6.1 API Documentation

{ "swagger": "2.0", "info": { "version": "v2", "title": "2N® Access Commander API", "description": "## Important note\nThis documentation file purpose is to help Access Commander development team as a reference manual. This file **IS NOT the official Access Commander API reference manual** and might NOT always reflect the actual version of the API endpoints. If you find any bug please report it to your distributor and he will schedule a fix into future releases.\n\n## Address\n\nThe URL of AccessCommander's API is versioned and uses https, i.e. the url looks like `https://serveraddress/api/v2/endpoint`, where:\n\n`serveraddress` is IP address of AC, \n\n`endpoint` - see section Paths.\n\n## HTTP\n\nHttp commands used for communication with the server:\n\n`GET` lists entities (getting the list of entities with parameter values)\n\n`PUT` updates the entity (change of some parameters typically)\n\n`POST` creates a new entity\n\n`DELETE` deletes the entity\n\n## Data Structure\n\n### Server Response\n\nResponse structure:\n\n```json\n{\n \"data\": {\n ...\n }\n}\n```\n\nEvery response is wrapped in the object \"data\". This arrangement offers the advantage of sending metadata in the response, for instance:\n\n```json\n{\n \"meta\": {\n \"code\": 200\n },\n \"data\": {\n ...\n },\n \"pagination\": {\n \"next_url\": \"...\",\n \"next_max_id\": \"13872296\"\n }\n}\n```\n\n### Errors\n`401` unauthorized\n\n`500 and higher` server errors, the structure looks like this:\n\n```json\n{\n \"data\": {\n errornumber:123456\n errortext:\"example\"\n }\n}\n```\n## Authentication\n\nThe user sends a request containing username and password to the endpoint `/login`.\nIf the pair is valid, the server creates the cookie and sends it back to the browser.\nAll consequent requests are sent to the server along with the cookie. The server always verifies\nif the cookie is valid. If it is not, it returns 401 in response. The cookie is deleted by sending \nrequest to the endpoint `/logout`.\n\n## Version Number and Tags\n" }, "basePath": "/api/v2", "schemes": [ "https" ], "consumes": [ "application/json", "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ { "name": "companies", "description": "Company entity" }, { "name": "zones", "description": "Zone entity" }, { "name": "groups", "description": "Group entity" }, { "name": "users", "description": "User entity" }, { "name": "devices", "description": "Device entity" }, { "name": "auth", "description": "Logging in and out" }, { "name": "accessRules", "description": "Access Rule entity" }, { "name": "timeProfiles", "description": "Time Profile entity" }, { "name": "attendance", "description": "Attendance entity" }, { "name": "presence", "description": "Presence entity" }, { "name": "search", "description": "Searching functionality" }, { "name": "system", "description": "System entity" }, { "name": "notifications", "description": "Notification entity" }, { "name": "days", "description": "Day entity" }, { "name": "intervals", "description": "Interval entity" }, { "name": "ldap", "description": "LdapSettings entity" }, { "name": "snapshots", "description": "Snapshot entity" }, { "name": "eventTypes", "description": "EventType entity" }, { "name": "codes", "description": "Code entity" }, { "name": "cards", "description": "Card entity" }, { "name": "fingerprints", "description": "Fingerprint entity" }, { "name": "mobileKey", "description": "Mobile Key entity" }, { "name": "visitorCards", "description": "Visitor Card entity" }, { "name": "visitors", "description": "Visitor entity" }, { "name": "antiPassback", "description": "AntiPassback" }, { "name": "userRight", "description": "Right of ordinary user" }, { "name": "adminRight", "description": "Administrator right" }, { "name": "accessManagerRight", "description": "Right of manager of access" }, { "name": "userManagerRight", "description": "Right of manager of users" }, { "name": "attendanceManagerRight", "description": "Right of manager of attendance" }, { "name": "anonymous", "description": "Login is not required to access the endpoint" } ], "paths": { "/accessrules": { "get": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Returns a list of Access Rules", "responses": { "200": { "description": "The list of Access Rules", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessRule" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Creates a new Access Rule", "parameters": [ { "in": "body", "name": "AccessRule", "description": "The object to create the Access Rule from", "required": true, "schema": { "$ref": "#/definitions/AccessRule" } } ], "responses": { "200": { "description": "The detail of the created Access Rule", "schema": { "$ref": "#/definitions/AccessRule" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/accessrules/{ruleId}": { "get": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Returns a detail of the Access Rule", "parameters": [ { "in": "path", "name": "ruleId", "description": "ID of the Access Rule", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Access Rule", "schema": { "$ref": "#/definitions/AccessRule" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Performs a change of the Access Rule", "parameters": [ { "in": "path", "name": "ruleId", "description": "ID of the Access Rule", "required": true, "type": "string" }, { "in": "body", "name": "AccessRule", "description": "The edited AccessRule", "required": true, "schema": { "$ref": "#/definitions/AccessRule" } } ], "responses": { "200": { "description": "The detail of the Access Rule", "schema": { "$ref": "#/definitions/AccessRule" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Deletes the Access Rule", "parameters": [ { "in": "path", "name": "ruleId", "description": "ID of the Access Rule", "required": true, "type": "string" }, { "in": "body", "name": "AccessRule", "description": "The AccessRule to delete", "required": true, "schema": { "$ref": "#/definitions/AccessRule" } } ], "responses": { "204": { "description": "The Access Rule has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/accessrules/bulk": { "post": { "tags": [ "accessRules", "adminRight", "accessManagerRight" ], "description": "Create bulk access rules for each of input combination (cartesian product of given groups and roles)", "parameters": [ { "in": "body", "name": "BulkAccessRules", "description": "The edited AccessRule", "required": true, "schema": { "$ref": "#/definitions/BulkAccessRules" } } ], "responses": { "200": { "description": "The list of Access Rules", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessRule" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies": { "get": { "tags": [ "companies", "adminRight", "userManagerRight", "accessManagerRight", "attendanceManagerRight" ], "description": "Returns a list of Companies (managers only own company)", "responses": { "200": { "description": "The list of Companies", "schema": { "type": "array", "items": { "$ref": "#/definitions/Company" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "companies", "adminRight" ], "description": "Creates a new Company", "parameters": [ { "name": "Company", "in": "body", "description": "The object to create the Company from", "required": true, "schema": { "$ref": "#/definitions/basePOST" } } ], "responses": { "200": { "description": "The detail of the created Company", "schema": { "$ref": "#/definitions/Company" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/validate": { "put": { "tags": [ "companies", "adminRight" ], "description": "Checks if a provided name is available for a new company", "parameters": [ { "name": "Name", "in": "body", "description": "Name to check existence of", "required": true, "schema": { "$ref": "#/definitions/basePOST" } } ], "responses": { "204": { "description": "Name does not exits" }, "500": { "description": "Name already exists" } } } }, "/companies/{companyId}": { "get": { "tags": [ "companies", "adminRight" ], "description": "Returns a detail of the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Company", "schema": { "$ref": "#/definitions/Company" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "companies", "adminRight" ], "description": "Performs a change of the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "Company", "description": "The edited Company", "required": true, "schema": { "$ref": "#/definitions/Company" } } ], "responses": { "200": { "description": "The detail of the Company", "schema": { "$ref": "#/definitions/Company" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "companies", "adminRight" ], "description": "Deletes the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "Company", "description": "The Company to delete", "required": true, "schema": { "$ref": "#/definitions/Company" } } ], "responses": { "204": { "description": "The company has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/attendancesetting": { "put": { "tags": [ "companies", "adminRight" ], "description": "Performs a change of the Attendance Setting of the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "AttendanceSetting", "description": "The edited AttendanceSetting", "required": true, "schema": { "$ref": "#/definitions/AttendanceSetting" } } ], "responses": { "200": { "description": "The detail of Attendance Setting of the Company", "schema": { "$ref": "#/definitions/AttendanceSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/commonsetting": { "put": { "tags": [ "companies", "adminRight" ], "description": "Performs a change of a Common Setting of the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "CommonSetting", "description": "The edited CommonSetting", "required": true, "schema": { "$ref": "#/definitions/CommonSetting" } } ], "responses": { "200": { "description": "The detail of the Common Setting of the Company", "schema": { "$ref": "#/definitions/CommonSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/devices": { "get": { "tags": [ "companies", "devices", "adminRight" ], "description": "Returns a list of Devices associated with the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Devices associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/simpleDevice" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/devices/{deviceId}/importUsers": { "put": { "tags": [ "companies", "devices", "adminRight" ], "description": "Performs the import of users from the Device to the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "string" } ], "responses": { "204": { "description": "The import has been successfuly started" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/groups": { "get": { "tags": [ "companies", "groups", "adminRight", "userManagerRight" ], "description": "Returns a list of Groups associated with the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Groups associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/users": { "get": { "tags": [ "companies", "adminRight" ], "description": "Returns a list of Users associated with the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Users associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/zones": { "put": { "tags": [ "companies", "zones", "adminRight" ], "description": "Associates the Zone with the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "Zones", "description": "Zones to add to the Company", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/idObject" } } } ], "responses": { "200": { "description": "The list of Zones associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/Zone" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "companies", "zones", "adminRight" ], "description": "Dissociates the Zone from the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "Zones", "description": "Zones to remove from the Company", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/idObject" } } } ], "responses": { "200": { "description": "The list of Zones associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/Zone" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/holidays": { "get": { "tags": [ "companies", "adminRight" ], "description": "Returns a list of Holidays observed by the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Holidays observed by the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/Holiday" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "companies", "adminRight" ], "description": "Creates a new Holiday", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "Holiday", "description": "The object to create the Holiday from. If the property Year is null, it means that it is valid any year.", "required": true, "schema": { "$ref": "#/definitions/Holiday" } } ], "responses": { "200": { "description": "The detail of the created Holiday", "schema": { "$ref": "#/definitions/Holiday" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/holidays/{holidayId}": { "get": { "tags": [ "companies", "adminRight" ], "description": "Returns a detail of the Holiday", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "holidayId", "description": "ID of the Holiday", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Holiday", "schema": { "$ref": "#/definitions/Holiday" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "companies", "adminRight" ], "description": "Performs a change of the Holiday", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "holidayId", "description": "ID of the Holiday", "required": true, "type": "integer" }, { "in": "body", "name": "Holiday", "description": "The edited Holiday.", "required": true, "schema": { "$ref": "#/definitions/Holiday" } } ], "responses": { "200": { "description": "The detail of the Holiday", "schema": { "$ref": "#/definitions/Holiday" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "companies", "adminRight" ], "description": "Deletes the Holiday", "parameters": [ { "in": "path", "type": "integer", "name": "companyId", "description": "ID of the Company", "required": true }, { "in": "path", "type": "integer", "name": "holidayId", "description": "ID of the Holiday", "required": true }, { "in": "body", "name": "Holiday", "description": "The Holiday to delete", "required": true, "schema": { "$ref": "#/definitions/Holiday" } } ], "responses": { "204": { "description": "The Holiday has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/holidays/copy": { "put": { "tags": [ "companies", "adminRight" ], "description": "Performs copying of the Holiday from another Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the target Company", "required": true, "type": "string" }, { "in": "body", "name": "Company", "description": "the source Company", "required": true, "schema": { "$ref": "#/definitions/idObjectInt" } } ], "responses": { "200": { "description": "The list of Holidays observed by the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/Holiday" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/import.csv": { "put": { "tags": [ "companies", "adminRight" ], "description": "Performs the import of CSV data to the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "file", "description": "CSV file as multipart/form-data", "required": true, "schema": { "type": "string", "format": "file-csv" } } ], "responses": { "204": { "description": "The CSV data has been imported to the Company" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/ldap": { "get": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Returns the list of LDAP settings associated with the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of LDAP settings associated with the Company", "schema": { "type": "array", "items": { "$ref": "#/definitions/LdapSettings" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Creates a new LDAP settings associated with the company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "LdapSettings", "description": "The object to create the LDAP settings from", "required": true, "schema": { "$ref": "#/definitions/LdapSettings" } } ], "responses": { "200": { "description": "Created LDAP settings", "schema": { "$ref": "#/definitions/LdapSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/ldap/{settingId}": { "get": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Returns LDAP settings", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "settingId", "description": "ID of the LDAP settings", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the LDAP settings", "schema": { "$ref": "#/definitions/LdapSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Performs a change of the LDAP settings", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "settingId", "description": "ID of the LDAP settings", "required": true, "type": "integer" }, { "in": "body", "name": "LdapSettings", "description": "The edited LDAP settings", "required": true, "schema": { "$ref": "#/definitions/LdapSettings" } } ], "responses": { "200": { "description": "The detail of the", "schema": { "$ref": "#/definitions/LdapSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Removes the LDAP settings from the Company", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "settingId", "description": "ID of the LDAP settings", "required": true, "type": "integer" }, { "in": "body", "name": "LdapSettings", "description": "The edited LDAP settings", "required": true, "schema": { "$ref": "#/definitions/LdapSettings" } } ], "responses": { "204": { "description": "The LDAP settings has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/ldap/{settingId}/synchronize": { "get": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Returns the status of LDAP synchronization", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "settingId", "description": "ID of the LDAP settings", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The status of LDAP synchronization", "schema": { "$ref": "#/definitions/LdapStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Performs LDAP synchronization", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "path", "name": "settingId", "description": "ID of the LDAP settings", "required": true, "type": "integer" } ], "responses": { "204": { "description": "LDAP synchronization has been started" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/companies/{companyId}/ldap/test": { "put": { "tags": [ "companies", "ldap", "adminRight" ], "description": "Performs LDAP test", "parameters": [ { "in": "path", "name": "companyId", "description": "ID of the Company", "required": true, "type": "integer" }, { "in": "body", "name": "LdapSettings", "description": "The edited LDAP settings", "required": true, "schema": { "$ref": "#/definitions/LdapSettings" } } ], "responses": { "204": { "description": "The LDAP test has been successfuly completed" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/dashboard/info": { "get": { "tags": [ "dashboard" ], "description": "Info for the Dashboard", "responses": { "200": { "description": "Info for the Dashboard", "schema": { "$ref": "#/definitions/DashboardInfo" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a list of Devices", "responses": { "200": { "description": "The list of Devices", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "devices", "adminRight" ], "description": "Creates new Devices from the array if they are found in the network.", "parameters": [ { "in": "body", "name": "Devices", "description": "the array of objects to create Devices from", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } } ], "responses": { "200": { "description": "The list of Devices", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "unauthorized", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "tags": [ "devices", "adminRight" ], "description": "Multiple asynchronous devices activation/deactivation (according to IsEnabled property)", "parameters": [ { "in": "body", "name": "Devices", "description": "the Devices array", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } } ], "responses": { "200": { "description": "No Content" }, "default": { "description": "unauthorized", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/scannetwork": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a list of Devices found in the network", "responses": { "200": { "description": "The list of Devices found in the network", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a detail of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Device", "schema": { "$ref": "#/definitions/Device" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Performs a change of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The edited Device", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "200": { "description": "The detail of the Device", "schema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/Device" } } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "devices", "adminRight" ], "description": "Deletes the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The Device to delete", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "200": { "description": "The list of Devices", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/cleardirectory": { "delete": { "tags": [ "devices", "adminRight" ], "description": "Deletes the Device and clears entries from the device directory", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The Device to delete", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "204": { "description": "The Device has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/factoryreset": { "delete": { "tags": [ "devices", "adminRight" ], "description": "Deletes the Device and performs factory reset of removed device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The Device to delete", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "204": { "description": "The Device has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/update": { "put": { "tags": [ "devices", "adminRight" ], "description": "Upgrades device firmware to version specified in the system", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "204": { "description": "The Device upgrade has started successfully" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/firmware": { "put": { "tags": [ "devices", "adminRight" ], "description": "Uploads user provided firmware file to device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "formData", "name": "firmwareFile", "type": "file", "description": "Firmware package file" } ], "responses": { "204": { "description": "Uploads and applies provided firmware package" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/buttons/{buttonNumber}": { "put": { "tags": [ "devices", "adminRight" ], "description": "Performs a change of the Button", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "buttonNumber", "description": "ID of the Button", "required": true, "type": "integer" }, { "in": "body", "name": "Button", "description": "The list of IDs of users to be associated with the Button", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "204": { "description": "The Button has been successfully updated" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/keypad": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a list of Quick Dial Buttons", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Quick Dial Buttons", "schema": { "type": "array", "items": { "$ref": "#/definitions/Keypad" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "devices", "adminRight" ], "description": "Assigns new Quick Dial Button", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Keypad", "description": "The object to create the Quick Dial Button from", "required": true, "schema": { "$ref": "#/definitions/Keypad" } } ], "responses": { "200": { "description": "The detail of Quick Dial Button", "schema": { "$ref": "#/definitions/Keypad" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/keypad/{keypadId}": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a detail of the Quick Dial Button", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "keypadId", "description": "ID of the Quick Dial Button", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Quick Dial Button", "schema": { "$ref": "#/definitions/Keypad" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "devices", "adminRight" ], "description": "Deletes the Quick Dial Button", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "keypadId", "description": "ID of the Quick Dial Button", "required": true, "type": "integer" }, { "in": "body", "name": "Keypad", "description": "The Quick Dial Button to delete", "required": true, "schema": { "description": "Required from $ref: '#/definitions/Keypad'", "type": "object", "required": [ "ModifiedGuid" ], "properties": { "ModifiedGuid": { "type": "integer" } } } } ], "responses": { "204": { "description": "The Quick Dial Button has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/display/nametags": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns a list of Display Buttons", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Display Buttons", "schema": { "$ref": "#/definitions/DisplayNameTags" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Performs a change of Display Buttons", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "DisplayNameTags", "description": "The edited DisplayButtons", "required": true, "schema": { "$ref": "#/definitions/DisplayNameTags" } } ], "responses": { "200": { "description": "The list of Display Buttons", "schema": { "$ref": "#/definitions/DisplayNameTags" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/display/phonebook": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the configuration for the Display Phonebook", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the configuration for the Display Phonebook", "schema": { "$ref": "#/definitions/DisplayPhonebook" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Performs a change the configuration for Display Phonebook", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "DisplayPhonebook", "description": "The edited Display Phonebook", "required": true, "schema": { "$ref": "#/definitions/DisplayPhonebook" } } ], "responses": { "200": { "description": "Returns the configuration for the Display Phonebook", "schema": { "$ref": "#/definitions/DisplayPhonebook" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/display/phonebook/view": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the view of the Display Phonebook (Automatic Groups are decomposed to their particular Users)", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the view of the Display Phonebook (Automatic Groups are decomposed to their particular Users)", "schema": { "$ref": "#/definitions/DisplayPhonebook" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/floors": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns floors which can be configured for a device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Floors which can be configured for a device", "schema": { "type": "array", "items": { "$ref": "#/definitions/LiftFloor" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/floors/{floorId}": { "put": { "tags": [ "devices", "adminRight" ], "description": "Edits one floor", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "floorId", "description": "ID of the floor", "required": true, "type": "integer" }, { "in": "body", "name": "LiftFloor", "required": true, "schema": { "$ref": "#/definitions/LiftFloor" } } ], "responses": { "200": { "description": "The floor has been successfuly edited", "schema": { "$ref": "#/definitions/LiftFloor" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/backup": { "put": { "tags": [ "devices", "adminRight" ], "description": "Launches bulk Backup of selected Devices", "parameters": [ { "in": "body", "name": "Devices", "description": "Devices to Backup", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/idObjectInt" } } } ], "responses": { "204": { "description": "The bulk backup of Devices has been started" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/backup": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the list of Backups of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the list of Backups of the Device", "schema": { "type": "array", "items": { "$ref": "#/definitions/Backup" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Launches the Backup of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "204": { "description": "The backup of Devices has been started" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/backup/download": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the file containing Backup of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the file containing Backup of the Device", "schema": { "type": "string", "format": "XML" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/replace": { "put": { "tags": [ "devices", "adminRight" ], "description": "Replace device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of replaced Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The new Device", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "200": { "description": "Replaced Device", "schema": { "$ref": "#/definitions/Device" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/restore": { "put": { "tags": [ "devices", "adminRight" ], "description": "Restores the Device using its last Backup", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the State of Restore of the Device", "schema": { "$ref": "#/definitions/baseState" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/restore/{backupId}": { "put": { "tags": [ "devices", "adminRight" ], "description": "Restores the selected Device using (any) given Backup", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "backupId", "description": "ID of the Backup", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the State of Restore of the Device", "schema": { "$ref": "#/definitions/baseState" } }, "default": { "description": "Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/synchronize": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the State of synchronization", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the State of synchronization", "schema": { "$ref": "#/definitions/baseState" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Launches the synchronization of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the State of synchronization", "schema": { "$ref": "#/definitions/baseState" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/proxy": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns an HTML response of logged-in Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns an HTML response of logged-in Device", "schema": { "type": "string", "format": "HTML" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/status": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns Status of Devices", "responses": { "200": { "description": "Returns Status of Devices", "schema": { "type": "array", "items": { "$ref": "#/definitions/DeviceStatus" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/status": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns Status of the Device", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns Status of the Device", "schema": { "$ref": "#/definitions/DeviceStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/password": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns the Device Password", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the Device Password", "schema": { "$ref": "#/definitions/DevicePassword" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Change Device password", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The Device with changed password", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "200": { "description": "Returns a new strong Password", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/password/generate": { "put": { "tags": [ "devices", "adminRight" ], "description": "Generates and sets the strong Device Password", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "body", "name": "Device", "description": "The Device to change", "required": true, "schema": { "$ref": "#/definitions/Device" } } ], "responses": { "200": { "description": "Returns the Device", "schema": { "$ref": "#/definitions/Device" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/switches/{switchId}": { "get": { "tags": [ "devices", "adminRight" ], "description": "Returns settings of the device's switch", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "switchId", "description": "ID of the device's switch", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the device's switch settings", "schema": { "$ref": "#/definitions/SwitchSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "devices", "adminRight" ], "description": "Sets the device's switch status ('on', 'off', 'trigger')", "parameters": [ { "in": "path", "name": "deviceId", "description": "ID of the Device", "required": true, "type": "integer" }, { "in": "path", "name": "switchId", "description": "ID of the device's switch", "required": true, "type": "integer" }, { "in": "body", "name": "SwitchAction", "description": "The action of the switch", "required": true, "schema": { "$ref": "#/definitions/SwitchAction" } } ], "responses": { "200": { "description": "The device's switch has been set successfully", "schema": { "type": "boolean" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/deviceUpdate": { "get": { "tags": [ "deviceUpdate", "adminRight" ], "responses": { "200": { "description": "Returns state of device update feature", "schema": { "$ref": "#/definitions/DeviceUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "body", "name": "deviceUpdate", "description": "Edited object", "schema": { "$ref": "#/definitions/DeviceUpdate" } } ], "responses": { "200": { "description": "Returns state of device update feature", "schema": { "$ref": "#/definitions/DeviceUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/deviceUpdate/firmware/{firmwareId}/current": { "put": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "path", "name": "firmwareId", "required": true, "type": "string" }, { "in": "formData", "name": "file", "type": "file", "description": "Firmware package file" } ], "responses": { "200": { "description": "Uploads and deploys provided firmware package", "schema": { "$ref": "#/definitions/FirmwareDeploymentStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "path", "name": "firmwareId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Firmware deployment state after current version was removed", "schema": { "$ref": "#/definitions/FirmwareDeploymentStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/deviceUpdate/firmware/{firmwareId}/candidate/releasenotes": { "get": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "path", "name": "firmwareId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Release notes in text format", "schema": { "type": "string" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/deviceUpdate/firmware/{firmwareId}/candidate/deploy": { "put": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "path", "name": "firmwareId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Deploys firmware package found on update server", "schema": { "$ref": "#/definitions/FirmwareDeploymentStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/deviceUpdate/firmware/{firmwareId}/candidate/devicetest": { "put": { "tags": [ "deviceUpdate", "adminRight" ], "parameters": [ { "in": "path", "name": "firmwareId", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/simpleDevice" } } } ], "responses": { "200": { "description": "Devices which testing was started", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/devices/{deviceId}/snapshots/{timestamp}": { "get": { "tags": [ "devices", "snapshots" ], "parameters": [ { "in": "path", "name": "deviceId", "required": true, "type": "integer" }, { "in": "path", "name": "timestamp", "description": "Epoch seconds in ITC time zone", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Timestamps and URLs of individual snapshots", "schema": { "type": "array", "items": { "$ref": "#/definitions/Snapshot" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/groups": { "get": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns a list of Groups (attendance manager only groups under own management)", "responses": { "200": { "description": "The list of Groups", "schema": { "type": "array", "items": { "$ref": "#/definitions/Group" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "groups", "adminRight", "accessManagerRight" ], "description": "Creates a new Group", "parameters": [ { "in": "body", "name": "Group", "description": "The object to create the Group from", "required": true, "schema": { "$ref": "#/definitions/basePOSTwithCompany" } } ], "responses": { "200": { "description": "The detail of the created Group", "schema": { "$ref": "#/definitions/Group" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/groups/{groupId}": { "get": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Returns a detail of the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Group", "schema": { "$ref": "#/definitions/Group" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Performs a change of the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Group", "description": "The edited Group", "required": true, "schema": { "$ref": "#/definitions/Group" } } ], "responses": { "200": { "description": "The detail of the Group", "schema": { "$ref": "#/definitions/Group" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Deletes the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Group", "description": "The Group to delete", "required": true, "schema": { "$ref": "#/definitions/Group" } } ], "responses": { "204": { "description": "The Group has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/groups/{groupId}/users": { "put": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Adds Users to the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Users", "description": "The list of Users to add", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Users in the Group", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "groups", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Removes Users from the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Users", "description": "The list of Users to remove", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "204": { "description": "The list of Users in the Group" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/groups/{groupId}/visitorcards": { "put": { "tags": [ "groups", "visitorCards", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Adds Visitor cards to the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Users", "description": "The list of Visitors to add", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Visitor cards in the Group", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "groups", "visitorCards", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Removes Visitor cards from the Group", "parameters": [ { "in": "path", "name": "groupId", "description": "ID of the Group", "required": true, "type": "string" }, { "in": "body", "name": "Visitor cards", "description": "The list of Visitor cards to remove", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "204": { "description": "Visitor cards have been removed from the Group" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/login": { "get": { "tags": [ "auth" ], "description": "Returns the common info for the logged-in User", "responses": { "200": { "description": "Returns the common info for the logged-in User", "schema": { "$ref": "#/definitions/LoginInfo" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "auth", "anonymous" ], "description": "Logs in the User", "parameters": [ { "in": "body", "name": "UserLogin", "description": "The object carrying the log-in information (longTimeLogin - logout after one month)", "required": true, "schema": { "type": "object", "properties": { "login": { "type": "string" }, "password": { "type": "string" }, "longTimeLogin": { "type": "boolean" } } } } ], "responses": { "200": { "description": "Returns the common info for the logged-in User", "schema": { "$ref": "#/definitions/LoginInfo" } }, "423": { "description": "After 5 subsequent unsuccessful login attempts", "schema": { "type": "null" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/logout": { "put": { "tags": [ "auth" ], "description": "Logs out the User", "responses": { "200": { "description": "The User has been logged out", "schema": { "type": "null" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/passwordreset": { "put": { "tags": [ "auth" ], "description": "Will generate password reset code and send it to user via e-mail", "parameters": [ { "in": "body", "name": "PasswordResetData", "description": "Object with user's login", "required": true, "schema": { "$ref": "#/definitions/PasswordResetData" } } ], "responses": { "200": { "description": "Reset code was send", "schema": { "type": "null" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/passwordresetverification": { "put": { "tags": [ "auth" ], "description": "Verifies password reset code. If code is correct, api returns reset token required by /setnewpassword endpoint.", "parameters": [ { "in": "body", "name": "PasswordResetCodeData", "description": "Object with user's reset code", "required": true, "schema": { "$ref": "#/definitions/PasswordResetCodeData" } } ], "responses": { "200": { "description": "Reset code is correct", "schema": { "$ref": "#/definitions/PasswordResetTokenData" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/setnewpassword": { "put": { "tags": [ "auth" ], "description": "Set new password based on password reset token and perform login", "parameters": [ { "in": "body", "name": "SetNewPasswordData", "description": "Object with reset token and new password", "required": true, "schema": { "$ref": "#/definitions/SetNewPasswordData" } } ], "responses": { "200": { "description": "Returns the common info for the logged-in User", "schema": { "$ref": "#/definitions/LoginInfo" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications": { "get": { "tags": [ "notifications", "adminRight" ], "description": "Returns a list of Notifications", "responses": { "200": { "description": "The list of Notifications", "schema": { "type": "array", "items": { "$ref": "#/definitions/Notification" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "notifications", "adminRight" ], "description": "Creates a new Notification", "parameters": [ { "in": "body", "name": "Notification", "description": "The object to create the Notification from (only Name is required)", "required": true, "schema": { "$ref": "#/definitions/Notification" } } ], "responses": { "200": { "description": "The detail of the created Notification", "schema": { "$ref": "#/definitions/Notification" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications/clear": { "put": { "tags": [ "notifications", "adminRight" ], "description": "Clears notifications displayed in app bar", "responses": { "204": { "description": "Successfully cleared" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications/{notificationId}/recipients": { "put": { "tags": [ "notifications", "adminRight" ], "description": "Performs a change of the Notification recipients", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" }, { "in": "body", "name": "Recipients", "description": "The Notification recipients (External - emails, Users - IDs)", "required": true, "schema": { "$ref": "#/definitions/Recipients" } } ], "responses": { "204": { "description": "Successfully updated" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications/types": { "get": { "tags": [ "notifications", "adminRight" ], "description": "Returns a list of notification types", "responses": { "200": { "description": "The list of notification types", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications/{notificationId}": { "get": { "tags": [ "notifications", "adminRight" ], "description": "Returns a detail of the Notification", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Notification", "schema": { "$ref": "#/definitions/Notification" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "notifications", "adminRight" ], "description": "Performs a change of the Notification", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" }, { "in": "body", "name": "Notification", "description": "The edited Notification", "required": true, "schema": { "$ref": "#/definitions/Notification" } } ], "responses": { "200": { "description": "The detail of the Notification", "schema": { "$ref": "#/definitions/Notification" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "notifications", "adminRight" ], "description": "Deletes the Notification", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" }, { "in": "body", "name": "Notification", "description": "The Notification to delete (only ModifiedGuid is required)", "required": true, "schema": { "$ref": "#/definitions/Notification" } } ], "responses": { "204": { "description": "The Notification has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/notifications/{notificationId}/devices": { "put": { "tags": [ "notifications", "devices", "adminRight" ], "description": "Adds Devices to the Notification", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "description": "IDs of Devices to be added to the Notification", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of Devices associated with the Notification", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "notifications", "devices", "adminRight" ], "description": "Removes Devices from the Notification", "parameters": [ { "in": "path", "name": "notificationId", "description": "ID of the Notification", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "description": "IDs of Devices to be removed from the Notification", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of remaining Devices associated with the Notification", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/snapshots/statistics": { "get": { "tags": [ "snapshots", "adminRight" ], "responses": { "200": { "description": "Returns total count and timestamp of oldest snapshot", "schema": { "$ref": "#/definitions/SnapshotStatistics" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/snapshots/setting": { "get": { "tags": [ "snapshots", "adminRight" ], "description": "Returns a list of Snapshot's settings", "responses": { "200": { "description": "The list of Snapshot's settings", "schema": { "type": "array", "items": { "$ref": "#/definitions/SnapshotSetting" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "snapshots", "adminRight" ], "description": "Creates a new Snapshot's settings", "parameters": [ { "in": "body", "name": "Snapshot's settings", "description": "The object to create the Snapshot's settings from (Name and EventType only)", "required": true, "schema": { "$ref": "#/definitions/SnapshotSetting" } } ], "responses": { "200": { "description": "The detail of the created Snapshot's settings", "schema": { "$ref": "#/definitions/SnapshotSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/snapshots/setting/{settingId}": { "get": { "tags": [ "snapshots", "adminRight" ], "description": "Returns a detail of the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Snapshot's settings", "schema": { "$ref": "#/definitions/SnapshotSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "snapshots", "adminRight" ], "description": "Performs a change of the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" }, { "in": "body", "name": "Snapshot's settings", "description": "The edited Snapshot's settings", "required": true, "schema": { "$ref": "#/definitions/SnapshotSetting" } } ], "responses": { "200": { "description": "The detail of the Snapshot's settings", "schema": { "$ref": "#/definitions/SnapshotSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "snapshots", "adminRight" ], "description": "Deletes the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" }, { "in": "body", "name": "Snapshot's settings", "description": "The Snapshot's settings to delete", "required": true, "schema": { "$ref": "#/definitions/SnapshotSetting" } } ], "responses": { "204": { "description": "The Snapshot's settings has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/snapshots/setting/{settingId}/devices": { "get": { "tags": [ "snapshots", "devices", "adminRight" ], "description": "Returns a list of Devices associated with the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of Devices associated with the Snapshot's settings", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "snapshots", "devices", "adminRight" ], "description": "Adds Devices to the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "description": "Devices to be added to the Snapshot's settings", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of Devices associated with the Snapshot's settings", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "snapshots", "devices", "adminRight" ], "description": "Removes Devices from the Snapshot's settings", "parameters": [ { "in": "path", "name": "settingId", "description": "ID of the Snapshot's settings", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "description": "Devices to be removed from the Snapshot's settings", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of Devices associated with the Snapshot's settings", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/snapshots/setting/eventtypes": { "get": { "tags": [ "snapshots", "eventTypes", "adminRight" ], "description": "Returns a list of Event types associated with the Snapshot's settings", "responses": { "200": { "description": "The list of Event types associated with the Snapshot's settings", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/attendance": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the Attendance Setting", "responses": { "200": { "description": "Returns the Attendance Setting", "schema": { "$ref": "#/definitions/AttendanceMode" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Performs a change of the Attendance Setting", "parameters": [ { "in": "body", "name": "AttendanceMode", "description": "The edited AttendanceMode", "required": true, "schema": { "$ref": "#/definitions/AttendanceMode" } } ], "responses": { "200": { "description": "Returns the Attendance Setting", "schema": { "$ref": "#/definitions/AttendanceMode" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/info": { "get": { "tags": [ "system", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns informations about system time", "responses": { "200": { "description": "Informations about system time", "schema": { "$ref": "#/definitions/SystemInfo" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/license": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the current license parameters", "responses": { "200": { "description": "Current license parameters", "schema": { "$ref": "#/definitions/License" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/license/import.xml": { "put": { "tags": [ "system", "adminRight" ], "description": "Upload of the License file", "parameters": [ { "in": "body", "name": "file", "description": "The License file", "required": true, "schema": { "type": "string", "format": "file-xml" } } ], "responses": { "200": { "description": "Returns the current License", "schema": { "$ref": "#/definitions/License" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/license/features": { "get": { "tags": [ "system" ], "responses": { "200": { "description": "Gets which features are supported by current license", "schema": { "$ref": "#/definitions/LicenseFeatures" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/license/activatebasic": { "put": { "tags": [ "system" ], "responses": { "200": { "description": "Basic license data", "schema": { "$ref": "#/definitions/License" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/logs/attendance": { "get": { "tags": [ "system", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "parameters": [ { "$ref": "#/parameters/accessLogCategoryParameter" }, { "$ref": "#/parameters/fromParameter" }, { "$ref": "#/parameters/toParameter" }, { "$ref": "#/parameters/userIdParameter" }, { "$ref": "#/parameters/deviceIdParameter" }, { "$ref": "#/parameters/zoneIdParameter" }, { "$ref": "#/parameters/companyIdParameter" }, { "$ref": "#/parameters/credentialsParameter" }, { "$ref": "#/parameters/freeSearchParameter" }, { "$ref": "#/parameters/directionParameter" } ], "description": "Returns a list of Access Logs", "responses": { "200": { "description": "The list of Access Logs", "schema": { "type": "array", "items": { "$ref": "#/definitions/AttendanceLog" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/logs/attendance/export.csv": { "get": { "tags": [ "system", "adminRight", "attendanceManagerRight" ], "description": "Performs an export of Access Logs to a CSV file. Can be filtered by URL query.", "responses": { "200": { "description": "The Access Logs as a CSV file", "schema": { "type": "file", "format": "csv" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/logs/system": { "get": { "tags": [ "system", "adminRight", "userManagerRight" ], "description": "Returns a list of System Logs", "parameters": [ { "$ref": "#/parameters/severityParameter" }, { "$ref": "#/parameters/fromParameter" }, { "$ref": "#/parameters/toParameter" }, { "$ref": "#/parameters/systemLogCategoryParameter" }, { "$ref": "#/parameters/authorIdParameter" }, { "$ref": "#/parameters/subjectParamater" }, { "$ref": "#/parameters/freeSearchParameter" } ], "responses": { "200": { "description": "The list of System Logs", "schema": { "type": "array", "items": { "$ref": "#/definitions/SystemLog" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/mobilekey": { "get": { "tags": [ "system", "mobileKey", "adminRight" ], "description": "Returns the Mobile Key settings", "responses": { "200": { "description": "Returns the Mobile Key settings", "schema": { "$ref": "#/definitions/MobileKey" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "mobileKey", "adminRight" ], "description": "Performs a change of Mobile Key settings", "parameters": [ { "in": "body", "name": "MobileKey", "description": "The edited Mobile Key", "required": true, "schema": { "$ref": "#/definitions/MobileKey" } } ], "responses": { "200": { "description": "The Mobile Key settings", "schema": { "$ref": "#/definitions/MobileKey" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/mobilekey/keys/{ordinal}": { "delete": { "tags": [ "system", "mobileKey", "adminRight" ], "description": "Deletes the Mobile Key at the ordinal position (keys at above positions are moved down)", "parameters": [ { "in": "path", "name": "ordinal", "description": "the ordinal of the key to delete", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Returns the Mobile Key settings", "schema": { "$ref": "#/definitions/MobileKeys" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/mobilekey/keys": { "post": { "tags": [ "system", "mobileKey", "adminRight" ], "description": "Generates the new Mobile Key and places it to ordinal 1 (the current keys are moved up)", "responses": { "200": { "description": "The Mobile Key settings", "schema": { "$ref": "#/definitions/MobileKeys" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/smtp": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the SMTP settings", "responses": { "200": { "description": "Returns the SMTP settings", "schema": { "$ref": "#/definitions/Smtp" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Performs a change of SMTP settings", "parameters": [ { "in": "body", "name": "Smtp", "description": "The edited Smtp", "required": true, "schema": { "$ref": "#/definitions/Smtp" } } ], "responses": { "200": { "description": "The SMTP settings", "schema": { "$ref": "#/definitions/Smtp" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/smtp/status": { "get": { "tags": [ "system" ], "description": "Returns the SMTP settings", "responses": { "200": { "description": "Returns the SMTP settings", "schema": { "type": "object", "properties": { "Enabled": { "type": "boolean" } } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/smtp/sendtestemail": { "put": { "tags": [ "system", "adminRight" ], "description": "Sends a testing email", "parameters": [ { "in": "body", "name": "EmailTo", "description": "The address to send the testing email to", "required": true, "schema": { "type": "object", "required": [ "emailTo" ], "properties": { "emailTo": { "type": "string" } } } } ], "responses": { "204": { "description": "The testing email has been sent" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/http": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the HTTP settings", "responses": { "200": { "description": "Returns the HTTP settings", "schema": { "$ref": "#/definitions/HttpSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Performs a change of HTTP settings", "parameters": [ { "in": "body", "name": "Smtp", "description": "The edited HTTP Settings", "required": true, "schema": { "$ref": "#/definitions/HttpSettings" } } ], "responses": { "200": { "description": "The HTTP settings", "schema": { "$ref": "#/definitions/HttpSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/updatesetting": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the update setting", "responses": { "200": { "description": "Returns the update setting", "schema": { "$ref": "#/definitions/UpdateSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Changes the update setting", "parameters": [ { "in": "body", "name": "UpdateSetting", "required": true, "schema": { "$ref": "#/definitions/UpdateSetting" } } ], "responses": { "200": { "description": "Returns changed update setting", "schema": { "$ref": "#/definitions/UpdateSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/update/status": { "get": { "tags": [ "system", "adminRight" ], "description": "Returns the System Update status", "responses": { "200": { "description": "Returns the System Update status", "schema": { "$ref": "#/definitions/SystemUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/update/check": { "get": { "tags": [ "system", "adminRight" ], "description": "Checks availability of update on 2N Update Server", "responses": { "200": { "description": "Returns the System Update status", "schema": { "$ref": "#/definitions/SystemUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/update/download": { "get": { "tags": [ "system", "adminRight" ], "description": "Starts downloading the package from 2N Update Server", "responses": { "200": { "description": "Package download has started", "schema": { "$ref": "#/definitions/SystemUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "system", "adminRight" ], "description": "Cancels package downloading or deletes already downloaded package", "responses": { "200": { "description": "Downloading has been successfuly cancelled", "schema": { "$ref": "#/definitions/SystemUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/update/run": { "put": { "tags": [ "system", "adminRight" ], "description": "Performs the System Update", "responses": { "200": { "description": "The Update is in progress", "schema": { "$ref": "#/definitions/SystemUpdate" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/licenseagreement": { "get": { "tags": [ "system", "adminRight" ], "description": "Shows info about license agreement", "responses": { "200": { "description": "Shows flag determining if license agreement should be displayed to the user", "schema": { "type": "object", "properties": { "ShowLicenseAgreement": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Sets flag determining if license agreement should be displayed to the user", "parameters": [ { "in": "body", "required": true, "name": "LicenseSetting", "description": "ahoj", "schema": { "$ref": "#/definitions/LicenseAgreementModification" } } ], "responses": { "200": { "description": "Shows flag determining if license agreement should be displayed to the user", "schema": { "type": "object", "properties": { "ShowLicenseAgreement": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/data/synchronization/import.csv": { "put": { "tags": [ "system", "synchronization", "adminRight" ], "description": "Performs the synchronization from local CSV file immediately.", "parameters": [ { "in": "body", "name": "file", "description": "multipart/form-data", "required": true, "schema": { "type": "string", "format": "file-csv" } } ], "responses": { "200": { "description": "The Synchronization Settings", "schema": { "$ref": "#/definitions/SynchronizationSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/data/synchronization/run": { "put": { "tags": [ "system", "synchronization", "adminRight" ], "description": "Performs the synchronization from FTP server immediately.", "responses": { "200": { "description": "The Synchronization Settings", "schema": { "$ref": "#/definitions/SynchronizationSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/data/synchronization/status": { "get": { "tags": [ "system", "synchronization", "adminRight" ], "description": "Gets the Synchronization status.", "responses": { "200": { "description": "The Synchronization status", "schema": { "$ref": "#/definitions/SynchronizationStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/data/synchronization": { "get": { "tags": [ "system", "synchronization", "adminRight" ], "description": "Gets the Synchronization Settings.", "responses": { "200": { "description": "The Synchronization Settings", "schema": { "$ref": "#/definitions/SynchronizationSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "synchronization", "adminRight" ], "description": "Updates the Synchronization Settings.", "parameters": [ { "in": "body", "name": "SynchronizationSettings", "description": "Synchronization Settings", "required": true, "schema": { "$ref": "#/definitions/SynchronizationSettings" } } ], "responses": { "200": { "description": "The Synchronization Settings has been successfuly updated", "schema": { "$ref": "#/definitions/SynchronizationSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/verification/loadimage": { "put": { "tags": [ "system", "verification", "anonymous" ], "description": "Creates new Captcha for the key-identified-subject.", "parameters": [ { "in": "body", "name": "VerificationKey", "description": "The key to identify the Subject which does the verification", "required": true, "schema": { "$ref": "#/definitions/VerificationKey" } } ], "responses": { "200": { "description": "The image representation of a new created Captcha", "schema": { "$ref": "#/definitions/VerificationObject" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/verification": { "put": { "tags": [ "system", "verification", "anonymous" ], "description": "Verifies the Captcha by the key-identified-subject.", "parameters": [ { "in": "body", "name": "VerificationPair", "description": "The key to identify the Subject performing verification and the text representation of the Captcha", "required": true, "schema": { "$ref": "#/definitions/VerificationPair" } } ], "responses": { "204": { "description": "Successful verification" }, "423": { "description": "Unsuccessful verification" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/diagnostic/package": { "get": { "tags": [ "system", "diagnostic", "adminRight" ], "description": "Gets the information of the status of the diagnostic file.", "responses": { "200": { "description": "The information of the status of the diagnostic file", "schema": { "$ref": "#/definitions/Diagnostics" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/diagnostic/package/create": { "put": { "tags": [ "system", "diagnostic", "adminRight" ], "description": "Launches the process of creation of a diagnostic file.", "responses": { "200": { "description": "The information of the status of the diagnostic file", "schema": { "$ref": "#/definitions/Diagnostics" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/diagnostic/package/download": { "get": { "tags": [ "system", "diagnostic", "adminRight" ], "description": "Downloads the diagnostic file.", "responses": { "200": { "description": "The diagnostic file", "schema": { "type": "file", "format": "tgz" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/diagnostic/statistics": { "get": { "tags": [ "system", "diagnostic", "adminRight" ], "description": "Gets the Statistics status.", "responses": { "200": { "description": "The Statistics status", "schema": { "$ref": "#/definitions/StatisticsStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "diagnostic", "adminRight" ], "description": "Sets the Statistics status.", "parameters": [ { "in": "body", "name": "StatisticsStatus", "required": true, "schema": { "$ref": "#/definitions/StatisticsStatus" } } ], "responses": { "200": { "description": "The Statistics status.", "schema": { "$ref": "#/definitions/StatisticsStatus" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/dataarchive": { "get": { "tags": [ "system", "adminRight" ], "description": "Gets the settings of the CamLog repository.", "responses": { "200": { "description": "The settings of the CamLog repository", "schema": { "$ref": "#/definitions/CameraLogs" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Updates the settings of the CamLog repository.", "parameters": [ { "in": "body", "name": "CamLogs", "description": "The edited settings of the CamLog repository", "required": true, "schema": { "$ref": "#/definitions/CameraLogs" } } ], "responses": { "200": { "description": "The settings of the CamLog repository", "schema": { "$ref": "#/definitions/CameraLogs" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/compatible": { "get": { "tags": [ "system", "adminRight" ], "description": "Gets the list of firmware incompatibilities.", "responses": { "200": { "description": "The list of firmware incompatibilities", "schema": { "type": "array", "items": { "$ref": "#/definitions/Compatibility" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Updates approvals of firmware incompatibilities.", "parameters": [ { "in": "body", "name": "CamLogs", "description": "The edited approvals of firmware incompatibilities", "required": true, "schema": { "$ref": "#/definitions/Compatibility" } } ], "responses": { "200": { "description": "The list of firmware incompatibilities", "schema": { "type": "array", "items": { "$ref": "#/definitions/Compatibility" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/compatible/versions": { "get": { "tags": [ "system", "adminRight" ], "description": "Gets the list of compatible firmware for product groups.", "responses": { "200": { "description": "The list of compatible firmware for product groups", "schema": { "type": "array", "items": { "$ref": "#/definitions/Compatibility" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/readers": { "get": { "tags": [ "system", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Gets settings of readers.", "responses": { "200": { "description": "Settings of readers", "schema": { "$ref": "#/definitions/ReadersSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Updates settings of readers.", "parameters": [ { "in": "body", "name": "ReadersSettings", "description": "The edited settings of readers", "required": true, "schema": { "$ref": "#/definitions/ReadersSettings" } } ], "responses": { "200": { "description": "Settings of readers", "schema": { "$ref": "#/definitions/ReadersSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/presence": { "get": { "tags": [ "system", "adminRight" ], "description": "Gets settings of presence.", "responses": { "200": { "description": "Settings of presence", "schema": { "$ref": "#/definitions/PresenceSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Updates settings of presence.", "parameters": [ { "in": "body", "name": "PresenceSettings", "description": "The edited settings of presence", "required": true, "schema": { "$ref": "#/definitions/PresenceSettings" } } ], "responses": { "200": { "description": "Settings of presence", "schema": { "$ref": "#/definitions/PresenceSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/spaceusage": { "get": { "tags": [ "system", "adminRight" ], "description": "Return information about current and history of disk space usage", "parameters": [ { "in": "query", "name": "days", "type": "integer", "required": false, "description": "Number of days to history" } ], "responses": { "200": { "description": "Disk usage", "schema": { "$ref": "#/definitions/SpaceUsage" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/system/loglifetime": { "get": { "tags": [ "system", "adminRight" ], "description": "Return setting of disk data retention", "responses": { "200": { "description": "Disk retention settings", "schema": { "$ref": "#/definitions/LogLifetime" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "system", "adminRight" ], "description": "Update disk data retention setting", "parameters": [ { "in": "body", "name": "DiskRetention", "description": "The edited settings of retention", "required": true, "schema": { "$ref": "#/definitions/LogLifetime" } } ], "responses": { "200": { "description": "Disk retention settings", "schema": { "$ref": "#/definitions/LogLifetime" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles": { "get": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Returns a list of Time Profiles", "responses": { "200": { "description": "The list of Time Profiles", "schema": { "type": "array", "items": { "$ref": "#/definitions/TimeProfile" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Creates a new Time Profile", "parameters": [ { "in": "body", "name": "TimeProfile", "description": "The object to create the Time Profile from", "required": true, "schema": { "properties": { "Name": { "type": "string" }, "Ordinal": { "type": "integer" } } } } ], "responses": { "200": { "description": "The detail of the created Time Profile", "schema": { "$ref": "#/definitions/TimeProfile" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/string": { "get": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Returns a list of Time Profiles", "responses": { "200": { "description": "List of Time Profiles as strings, e.g.: ['Name=[Working days] Ordinal=[0]','Name=[Weekends] Ordinal=[1]']", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/validate": { "put": { "tags": [ "timeProfiles", "adminRight" ], "description": "Checks if a provided name is available for a new time profile", "parameters": [ { "name": "Name", "in": "body", "description": "Name to check existence of", "required": true, "schema": { "$ref": "#/definitions/basePOST" } } ], "responses": { "204": { "description": "Name does not exits" }, "500": { "description": "Name already exists" } } } }, "/timeprofiles/{timeprofileId}": { "get": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Returns a detail of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Time Profile", "schema": { "$ref": "#/definitions/TimeProfile" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Performs a change of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "body", "name": "TimeProfile", "description": "The edited TimeProfile", "required": true, "schema": { "$ref": "#/definitions/TimeProfile" } } ], "responses": { "200": { "description": "The detail of the Time Profile", "schema": { "$ref": "#/definitions/TimeProfile" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "timeProfiles", "adminRight", "accessManagerRight" ], "description": "Deletes the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "body", "name": "TimeProfile", "description": "The TimeProfile to delete", "required": true, "schema": { "$ref": "#/definitions/TimeProfile" } } ], "responses": { "204": { "description": "The Time Profile has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/{timeprofileId}/days": { "get": { "tags": [ "timeProfiles", "days", "adminRight", "accessManagerRight" ], "description": "Returns a list of Days of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of Days of the Time Profile", "schema": { "type": "array", "items": { "$ref": "#/definitions/Day" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/{timeprofileId}/days/{dayOfWeek}": { "get": { "tags": [ "timeProfiles", "days", "adminRight", "accessManagerRight" ], "description": "Returns a detail of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "The day of week number", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Day of the Time Profile", "schema": { "$ref": "#/definitions/Day" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "timeProfiles", "days", "adminRight", "accessManagerRight" ], "description": "Performs a change of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "The day of week number", "required": true, "type": "integer" }, { "in": "body", "name": "Day", "required": true, "schema": { "type": "object", "properties": { "Enabled": { "type": "boolean" } } } } ], "responses": { "200": { "description": "The detail of the Day of the Time Profile", "schema": { "$ref": "#/definitions/Day" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/{timeprofileId}/days/{dayOfWeek}/intervals": { "get": { "tags": [ "timeProfiles", "days", "intervals", "adminRight", "accessManagerRight" ], "description": "Returns a list of Intervals of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "The day of week number", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Intervals of the Day of the Time Profile", "schema": { "type": "array", "items": { "$ref": "#/definitions/Interval" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "timeProfiles", "days", "intervals", "adminRight", "accessManagerRight" ], "description": "Creates new Intervals of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "Day of week number", "required": true, "type": "integer" }, { "in": "body", "name": "Intervals", "description": "The list of Intervals to create", "schema": { "type": "array", "items": { "type": "object", "properties": { "From": { "type": "string", "format": "time" }, "To": { "type": "string", "format": "time" } } } } } ], "responses": { "200": { "description": "The list of created Intervals", "schema": { "type": "array", "items": { "$ref": "#/definitions/Interval" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/timeprofiles/{timeprofileId}/days/{dayOfWeek}/intervals/{intervalId}": { "get": { "tags": [ "timeProfiles", "days", "intervals", "adminRight", "accessManagerRight" ], "description": "Returns a detail of the Interval of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "The day of week number", "required": true, "type": "integer" }, { "in": "path", "name": "intervalId", "description": "ID of the Interval", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Interval of the Day of the Time Profile", "schema": { "$ref": "#/definitions/Interval" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "timeProfiles", "days", "intervals", "adminRight", "accessManagerRight" ], "description": "Performs a change of the Interval of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "Day of week number", "required": true, "type": "integer" }, { "in": "path", "name": "intervalId", "description": "ID of the Interval", "required": true, "type": "integer" }, { "in": "body", "name": "Interval", "description": "The edited Interval", "required": true, "schema": { "$ref": "#/definitions/Interval" } } ], "responses": { "200": { "description": "The detail of the Interval", "schema": { "$ref": "#/definitions/Interval" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "timeProfiles", "days", "intervals", "adminRight", "accessManagerRight" ], "description": "Deletes the Interval of the Day of the Time Profile", "parameters": [ { "in": "path", "name": "timeprofileId", "description": "ID of the Time Profile", "required": true, "type": "string" }, { "in": "path", "name": "dayOfWeek", "description": "The day of week number", "required": true, "type": "integer" }, { "in": "path", "name": "intervalId", "description": "ID of the Interval", "required": true, "type": "integer" }, { "in": "body", "name": "Interval", "description": "The Interval to delete", "required": true, "schema": { "$ref": "#/definitions/Interval" } } ], "responses": { "200": { "description": "The detail of the Day of the Time Profile", "schema": { "$ref": "#/definitions/Day" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users": { "get": { "tags": [ "users", "userRight", "adminRight", "userManagerRight" ], "description": "Returns a list of Users. User objects in this list contain a hidden string properties PhoneNumberList (Phone Numbers, separated by colon) and CompanyName enabling to filter by.", "responses": { "200": { "description": "The list of Users", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Creates a new User", "parameters": [ { "in": "body", "name": "User", "description": "The object to create the User from", "required": true, "schema": { "$ref": "#/definitions/basePOSTwithCompany" } } ], "responses": { "200": { "description": "The detail of the created User", "schema": { "$ref": "#/definitions/User" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Deletes selected Users", "parameters": [ { "in": "body", "name": "Users", "description": "Required from $ref: '#/definitions/User'", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "204": { "description": "Users have been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/restrictedAccess": { "put": { "tags": [ "users", "adminRight" ], "description": "Performs bulk settings of access restriction on Users", "parameters": [ { "in": "body", "name": "Users", "description": "The edited Users", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserForBulkRestrictedAccess" } } } ], "responses": { "204": { "description": "Users have been updated" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/attendanceMonitoring": { "put": { "tags": [ "users", "adminRight" ], "description": "Performs bulk settings of attendance monitoring on Users", "parameters": [ { "in": "body", "name": "Users", "description": "The edited Users", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserForBulkAttendanceMonitoring" } } } ], "responses": { "204": { "description": "Users have been updated" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}": { "get": { "tags": [ "users", "userRight", "ownerRight", "adminRight", "userManagerRight", "accessManagerRight", "attendanceManagerRight" ], "description": "Returns a detail of the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the User", "schema": { "$ref": "#/definitions/User" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "ownerRight", "adminRight", "userManagerRight" ], "description": "Performs a change of the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "User", "description": "The edited User", "required": true, "schema": { "$ref": "#/definitions/UserForUpdate" } } ], "responses": { "200": { "description": "The detail of the User", "schema": { "$ref": "#/definitions/User" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Deletes the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "User", "description": "The User to delete (its ModifiedGuid is sufficient)", "required": true, "schema": { "$ref": "#/definitions/deletionObject" } } ], "responses": { "204": { "description": "The User has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/groups": { "put": { "tags": [ "users", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Adds a User to Groups", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Groups", "description": "Groups to which the User has to be added", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Groups associated with the User", "schema": { "type": "array", "items": { "$ref": "#/definitions/Group" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Removes a User from Groups", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Groups", "description": "Groups from which the User has to be removed", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Groups associated with the User", "schema": { "type": "array", "items": { "$ref": "#/definitions/Group" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/cards": { "post": { "tags": [ "users", "cards", "userRight", "adminRight", "userManagerRight" ], "description": "Creates a new Card for the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Card", "description": "The object to create the Card from", "required": true, "schema": { "description": "Required from $ref: '#/definitions/Card", "type": "object", "required": [ "Identification" ], "properties": { "Identification": { "type": "string" } } } } ], "responses": { "200": { "description": "The detail of the created Card", "schema": { "$ref": "#/definitions/Card" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/cards/{cardId}": { "put": { "tags": [ "users", "cards", "userRight", "adminRight", "userManagerRight" ], "description": "Performs a change of the Card", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "cardId", "description": "ID of the Card", "required": true, "type": "string" }, { "in": "body", "name": "Card", "description": "The edited Card", "required": true, "schema": { "$ref": "#/definitions/Card" } } ], "responses": { "200": { "description": "The detail of the Card", "schema": { "$ref": "#/definitions/Card" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "cards", "userRight", "adminRight", "userManagerRight" ], "description": "Deletes the Card", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "cardId", "description": "ID of the Card", "required": true, "type": "string" }, { "in": "body", "name": "Card", "description": "The Card to delete", "required": true, "schema": { "$ref": "#/definitions/Card" } } ], "responses": { "204": { "description": "The Card has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/codes": { "post": { "tags": [ "users", "codes", "adminRight", "userManagerRight" ], "description": "Creates a new Code for the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Code", "description": "The object to create the Code from", "required": true, "schema": { "description": "Required from $ref: '#/definitions/Code", "type": "object", "required": [ "SwitchCode", "Ordinal" ], "properties": { "SwitchCode": { "type": "string" }, "Ordinal": { "type": "integer" } } } } ], "responses": { "200": { "description": "The detail of the created Code", "schema": { "$ref": "#/definitions/Code" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/codes/{codeId}": { "put": { "tags": [ "users", "codes", "adminRight", "userManagerRight" ], "description": "Performs a change of the Code", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "codeId", "description": "ID of the Code", "required": true, "type": "string" }, { "in": "body", "name": "Code", "description": "The edited Code", "required": true, "schema": { "$ref": "#/definitions/Code" } } ], "responses": { "200": { "description": "The detail of the Code", "schema": { "$ref": "#/definitions/Code" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "codes", "adminRight", "userManagerRight" ], "description": "Deletes the Code", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "codeId", "description": "ID of the Code", "required": true, "type": "string" }, { "in": "body", "name": "Code", "description": "The Code to delete", "required": true, "schema": { "$ref": "#/definitions/Code" } } ], "responses": { "204": { "description": "The Code has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/fingerprints": { "get": { "tags": [ "users", "fingerprints", "userRight", "adminRight", "userManagerRight" ], "description": "Returns a list of Fingerprints of the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of Fingerprints of the User", "schema": { "type": "array", "items": { "$ref": "#/definitions/Fingerprint" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "users", "fingerprints", "adminRight", "userManagerRight" ], "description": "Creates a new Fingerprint for the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Fingerprint", "description": "The object to create the Fingerprint from", "required": true, "schema": { "description": "Required from $ref: '#/definitions/Fingerprint", "type": "object", "required": [ "Template" ], "properties": { "Template": { "type": "string" } } } } ], "responses": { "200": { "description": "The detail of the created Fingerprint", "schema": { "$ref": "#/definitions/Fingerprint" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/fingerprints/{fingerprintId}": { "get": { "tags": [ "users", "fingerprints", "userRight", "adminRight", "userManagerRight" ], "description": "Returns a detail of the Fingerprint", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "fingerprintId", "description": "ID of the Fingerprint", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The detail of the Fingerprint", "schema": { "$ref": "#/definitions/Fingerprint" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "fingerprints", "adminRight", "userManagerRight" ], "description": "Performs a change of the Fingerprint (void Template deletes the item)", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "fingerprintId", "description": "ID of the Fingerprint", "required": true, "type": "integer" }, { "in": "body", "name": "Fingerprint", "description": "The edited Fingerprint", "required": true, "schema": { "$ref": "#/definitions/Fingerprint" } } ], "responses": { "200": { "description": "The detail of the Fingerprint", "schema": { "$ref": "#/definitions/Fingerprint" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "fingerprints", "adminRight", "userManagerRight" ], "description": "Deletes the Fingerprint", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "fingerprintId", "description": "ID of the Fingerprint", "required": true, "type": "integer" }, { "in": "body", "name": "Fingerprint", "description": "The Fingerprint to delete", "required": true, "schema": { "$ref": "#/definitions/Fingerprint" } } ], "responses": { "204": { "description": "The Fingerprint has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey": { "get": { "tags": [ "users", "mobileKey", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns the settings and state of mobilekey", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of Phone Numbers of the User", "schema": { "type": "array", "items": { "$ref": "#/definitions/MobileKeyUser" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey/pairing/dongle": { "get": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Start mobile key pairing using USB dongle", "parameters": [ { "in": "path", "name": "userId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns data for the 2N USB driver application", "schema": { "$ref": "#/definitions/MobileKeyDonglePairingData" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Edits users mobile key pairing status", "parameters": [ { "in": "path", "name": "userId", "required": true, "type": "string" }, { "in": "body", "name": "authId", "required": true, "schema": { "$ref": "#/definitions/MobileKeyPairingSetObject" } } ], "responses": { "200": { "description": "Returns the State of Pairing", "schema": { "$ref": "#/definitions/MobileKeyUser" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey/pairing/start": { "put": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Start mobile key pairing", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the State of Pairing", "schema": { "$ref": "#/definitions/MobileKeyUser" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey/pairing/stop": { "put": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Stop mobile key pairing", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the State of Pairing", "schema": { "$ref": "#/definitions/MobileKeyUser" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey/{authId}": { "delete": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Deletes the Mobile Key", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "authId", "description": "Authorization Id of Mobile Key", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Mobile Key has been deleted", "schema": { "$ref": "#/definitions/MobileKeyUser" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/mobilekey/pairing/sendmail": { "put": { "tags": [ "users", "mobileKey", "adminRight", "userManagerRight" ], "description": "Sends Mobile Key pairing info via email", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "emails", "description": "The list of email adresses to send the info to", "required": true, "schema": { "$ref": "#/definitions/Emails" } } ], "responses": { "204": { "description": "Emails have been sent" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/settings": { "get": { "tags": [ "users", "settings", "adminRight" ], "description": "Returns a detail of the User Settings", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the User Settings", "schema": { "$ref": "#/definitions/UserSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "settings", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Performs a change of the User Settings", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "UserSettings", "description": "The edited User Settings", "required": true, "schema": { "$ref": "#/definitions/UserSettings" } } ], "responses": { "200": { "description": "The detail of the User Settings", "schema": { "$ref": "#/definitions/UserSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/right": { "get": { "tags": [ "users", "userRight", "adminRight" ], "description": "Returns a detail of the User Rights", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the User Rights", "schema": { "$ref": "#/definitions/Right" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "userRight", "adminRight" ], "description": "Performs a change of the User Rights", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "UserRights", "description": "The edited User Rights", "required": true, "schema": { "$ref": "#/definitions/Right" } } ], "responses": { "200": { "description": "The detail of the User Rights", "schema": { "$ref": "#/definitions/Right" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/password": { "put": { "tags": [ "users", "ownerRight", "adminRight" ], "description": "Performs a change of the User Password and sends notification e-mail", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "PasswordPair", "description": "The old and the new password", "required": true, "schema": { "$ref": "#/definitions/PasswordPair" } } ], "responses": { "200": { "description": "The detail of the User", "schema": { "$ref": "#/definitions/User" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/onetimepassword": { "put": { "tags": [ "users", "adminRight" ], "description": "Generate new temporary user Password and sends notification e-mail", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "OneTimePassword", "description": "The new password, only NewPassword field is used", "required": true, "schema": { "$ref": "#/definitions/OneTimePassword" } } ], "responses": { "204": { "description": "Password successfully generated and changed" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/generatepassword": { "put": { "tags": [ "users", "adminRight" ], "description": "Generate new temporary user Password and sends notification e-mail", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "204": { "description": "Password successfully generated and changed" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/avatar": { "put": { "tags": [ "users", "userRight", "adminRight" ], "description": "Changes user avatar", "parameters": [ { "in": "path", "name": "userId", "description": "Id of the user", "required": true, "type": "string" }, { "in": "formData", "name": "file", "type": "file", "description": "User avatar image" } ], "responses": { "204": { "description": "Avatar save successful" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "userRight", "adminRight" ], "description": "Changes user avatar", "parameters": [ { "in": "path", "name": "userId", "description": "Id of the user", "required": true, "type": "string" } ], "responses": { "204": { "description": "Avatar save successful" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/attendance": { "get": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns a list of Users monitored for Attendance", "responses": { "200": { "description": "The list of Users monitored for Attendance", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserOld" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/attendance/export.csv": { "put": { "tags": [ "attendance", "users", "adminRight", "userManagerRight", "attendanceManagerRight" ], "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.", "parameters": [ { "in": "body", "name": "time range and users", "description": "The month and users to export", "required": true, "schema": { "type": "object", "properties": { "From": { "description": "The start date of the month", "type": "string", "format": "date-time" }, "To": { "description": "The end date of the month", "type": "string", "format": "date-time" }, "Users": { "$ref": "#/definitions/baseListId" } } } } ], "responses": { "200": { "description": "The attendance data as a CSV file", "schema": { "type": "file", "format": "csv" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/attendance/export.csv": { "put": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Performs an export of attendance data to a CSV file", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "time from", "description": "The year and month to export", "required": true, "schema": { "type": "object", "properties": { "From": { "description": "The start date of the month", "type": "string", "format": "date" } } } } ], "responses": { "200": { "description": "The attendance data as a CSV file", "schema": { "type": "file", "format": "csv" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/attendance/export.pdf": { "put": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Performs an export of attendance data to a PDF file. There must be PdfConverter.exe running on the background.", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "time from", "description": "The year and month to export", "required": true, "schema": { "type": "object", "properties": { "From": { "description": "The start date of the month", "type": "string", "format": "date" } } } } ], "responses": { "200": { "description": "The attendance data as a PDF file", "schema": { "type": "file", "format": "pdf" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/attendance/export.pdf": { "put": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Performs an export of attendance data to a PDF file. There must be PdfConverter.exe running on the background.", "parameters": [ { "in": "body", "name": "time range and users", "description": "The month and users to export", "required": true, "schema": { "type": "object", "properties": { "From": { "description": "The start date of the month", "type": "string", "format": "date-time" }, "Users": { "$ref": "#/definitions/baseListId" } } } } ], "responses": { "200": { "description": "The attendance data as a PDF file", "schema": { "type": "file", "format": "pdf" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/attendance": { "get": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns the structured attendance data of the User within the current month", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The structured attendance data of the User", "schema": { "$ref": "#/definitions/UserAttendanceDetail" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/attendance/{year}/{month}/appointments": { "get": { "tags": [ "attendance", "users", "ownerRight", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns the structured attendance data of the User within the month", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "year", "description": "The year", "required": true, "type": "integer" }, { "in": "path", "name": "month", "description": "The month", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The structured attendance data of the User", "schema": { "$ref": "#/definitions/UserAttendanceDetail" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/appointments": { "post": { "tags": [ "attendance", "users", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Creates a new User Appointment", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "Appointment", "description": "The object to create the User Appointment from", "required": true, "schema": { "$ref": "#/definitions/Appointment" } } ], "responses": { "200": { "description": "Created User Appointment", "schema": { "$ref": "#/definitions/Appointment" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/appointments/{appointmentId}": { "get": { "tags": [ "attendance", "users", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns the User Appointment", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "appointmentId", "description": "ID of the Attendance Record", "required": true, "type": "integer" } ], "responses": { "200": { "description": "User Appointment", "schema": { "$ref": "#/definitions/Appointment" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "attendance", "users", "userManagerRight", "accessManagerRight", "attendanceManagerRight", "adminRight" ], "description": "Performs a change of the User Appointment", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "appointmentId", "description": "ID of the Attendance Record", "required": true, "type": "integer" }, { "in": "body", "name": "Appointment", "description": "The edited User Appointment", "required": true, "schema": { "$ref": "#/definitions/Appointment" } } ], "responses": { "200": { "description": "Edited User Appointment", "schema": { "$ref": "#/definitions/Appointment" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "attendance", "users", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Deletes the User Appointment", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "appointmentId", "description": "ID of the User Appointment", "required": true, "type": "integer" }, { "in": "body", "name": "Appointment", "description": "The User Appointment to delete", "required": true, "schema": { "$ref": "#/definitions/Appointment" } } ], "responses": { "204": { "description": "User Appointment has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/presence": { "get": { "tags": [ "presence", "users" ], "description": "Returns a list of present Users", "responses": { "200": { "description": "The list of present Users and their useful properties", "schema": { "type": "object", "properties": { "IsSpecifyingDirection": { "type": "boolean" }, "Present": { "type": "array", "items": { "$ref": "#/definitions/Presence" } } } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/restrictedaccess": { "put": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Set a Restricted Access for the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "RestrictedAccess", "description": "The object to set Restricted Access", "required": true, "schema": { "$ref": "#/definitions/RestrictedAccess" } } ], "responses": { "200": { "description": "The detail of the Restricted Access", "schema": { "$ref": "#/definitions/RestrictedAccess" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/readers": { "get": { "tags": [ "users", "adminRight", "accessManagerRight", "userManagerRight", "attendanceManagerRight" ], "description": "Returns the user settings of readers", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" } ], "responses": { "200": { "description": "The user settings of readers", "schema": { "$ref": "#/definitions/UserReadersSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "users", "adminRight", "userManagerRight" ], "description": "Set an user settings of readers", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "ReadersSettings", "description": "The object to set user settings of readers", "required": true, "schema": { "$ref": "#/definitions/UserReadersSettings" } } ], "responses": { "200": { "description": "The user settings of readers", "schema": { "$ref": "#/definitions/ReadersSettings" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/phonenumbers": { "post": { "tags": [ "users", "phonenumbers", "adminRight", "userManagerRight" ], "description": "Creates a new Phone Number for the User", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "body", "name": "PhoneNumber", "description": "The object to create the Phone Number from", "required": true, "schema": { "$ref": "#/definitions/PhoneNumber" } } ], "responses": { "200": { "description": "The detail of the created Phone Number", "schema": { "$ref": "#/definitions/PhoneNumber" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/users/{userId}/phonenumbers/{phoneNumberId}": { "put": { "tags": [ "users", "phonenumbers", "adminRight", "userManagerRight" ], "description": "Performs a change of the Phone Number", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "phoneNumberId", "description": "ID of the Phone Number", "required": true, "type": "integer" }, { "in": "body", "name": "PhoneNumber", "description": "The edited Phone Number", "required": true, "schema": { "$ref": "#/definitions/PhoneNumber" } } ], "responses": { "200": { "description": "The detail of edited Phone Number", "schema": { "$ref": "#/definitions/PhoneNumber" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "users", "phonenumbers", "adminRight", "userManagerRight" ], "description": "Deletes the Phone Number", "parameters": [ { "in": "path", "name": "userId", "description": "ID of the User", "required": true, "type": "string" }, { "in": "path", "name": "phoneNumberId", "description": "ID of the Phone Number", "required": true, "type": "integer" }, { "in": "body", "name": "PhoneNumber", "description": "The Phone Number to delete", "required": true, "schema": { "$ref": "#/definitions/PhoneNumber" } } ], "responses": { "204": { "description": "Phone Number have been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/visitorcards": { "get": { "tags": [ "visitorCards", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Returns a list of Visitor Cards.", "responses": { "200": { "description": "The list of Visitor Cards", "schema": { "type": "array", "items": { "$ref": "#/definitions/VisitorCard" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "visitorCards", "adminRight" ], "description": "Creates a new Visitor Card", "parameters": [ { "in": "body", "name": "VisitorCard", "description": "The object to create the Visitor Card from (Name and Identification only)", "required": true, "schema": { "$ref": "#/definitions/VisitorCard" } } ], "responses": { "200": { "description": "The detail of the created Visitor Card", "schema": { "$ref": "#/definitions/VisitorCard" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/visitorcards/{visitorcardId}": { "get": { "tags": [ "visitorCards", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Returns a detail of the Visitor Card", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Visitor Card", "schema": { "$ref": "#/definitions/VisitorCard" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "visitorCards", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Performs a change of the Visitor Card", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "body", "name": "VisitorCard", "description": "The edited Visitor Card", "required": true, "schema": { "$ref": "#/definitions/VisitorCard" } } ], "responses": { "200": { "description": "The detail of edited Visitor Card", "schema": { "$ref": "#/definitions/VisitorCard" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "visitorCards", "adminRight" ], "description": "Deletes selected Visitor Card", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "body", "name": "VisitorCard", "description": "The Visitor Card to delete", "required": true, "schema": { "$ref": "#/definitions/VisitorCard" } } ], "responses": { "204": { "description": "Visitor Card has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/visitorcards/{visitorcardId}/visitor/{visitorId}": { "put": { "tags": [ "visitorCards", "visitors", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "Creates or updates a Visitor associated with the Visitor Card", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "path", "name": "visitorId", "description": "0 (zero) to create a new Visitor or ID of the Visitor to edit", "required": true, "type": "integer" }, { "in": "body", "name": "Visitor", "description": "The edited Visitor", "required": true, "schema": { "$ref": "#/definitions/Visitor" } } ], "responses": { "200": { "description": "The complete Visitor Card", "schema": { "$ref": "#/definitions/VisitorCard" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "visitorCards", "visitors", "adminRight", "accessManagerRight", "userManagerRight" ], "description": "The Visitor has been deleted", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "path", "name": "visitorId", "description": "ID of the Visitor", "required": true, "type": "integer" }, { "in": "body", "name": "Visitor", "description": "The Visitor to be deleted", "required": true, "schema": { "$ref": "#/definitions/Visitor" } } ], "responses": { "200": { "description": "The complete Visitor Card", "schema": { "$ref": "#/definitions/VisitorCard" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/visitorcards/{visitorcardId}/groups": { "put": { "tags": [ "visitorCards", "groups", "adminRight" ], "description": "Adds a Visitor Card to Groups", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "body", "name": "Groups", "description": "Groups to which the Visitor Card has to be included", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Groups associated with the Visitor Card", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "visitorCards", "groups", "adminRight" ], "description": "Removes a Visitor Card from Groups", "parameters": [ { "in": "path", "name": "visitorcardId", "description": "ID of the Visitor Card", "required": true, "type": "string" }, { "in": "body", "name": "Groups", "description": "Groups from which the Visitor Card has to be excluded", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The list of Groups associated with the Visitor Card", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/zones": { "get": { "tags": [ "zones", "adminRight", "accessManagerRight" ], "description": "Returns a list of Zones", "responses": { "200": { "description": "The list of Zones", "schema": { "type": "array", "items": { "$ref": "#/definitions/Zone" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "zones", "adminRight" ], "description": "Creates a new Zone", "parameters": [ { "in": "body", "name": "Zone", "description": "The object to create the Zone from", "required": true, "schema": { "$ref": "#/definitions/basePOST" } } ], "responses": { "200": { "description": "The detail of the created Zone", "schema": { "$ref": "#/definitions/Zone" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/zones/{zoneId}": { "get": { "tags": [ "zones", "adminRight" ], "description": "Returns a detail of the Zone", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" } ], "responses": { "200": { "description": "The detail of the Zone", "schema": { "$ref": "#/definitions/Zone" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "zones", "adminRight" ], "description": "Performs a change of the Zone", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "body", "name": "Zone", "description": "The edited Zone", "required": true, "schema": { "$ref": "#/definitions/Zone" } } ], "responses": { "200": { "description": "The detail of the Zone", "schema": { "$ref": "#/definitions/Zone" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "zones", "adminRight" ], "description": "Deletes the Zone", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "body", "name": "Zone", "description": "The Zone to delete", "required": true, "schema": { "$ref": "#/definitions/Zone" } } ], "responses": { "204": { "description": "The Zone has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/zones/{zoneId}/companies": { "put": { "tags": [ "zones", "companies", "adminRight" ], "description": "Adds a Zone to Companies", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "body", "name": "Companies", "description": "Companies to which the Zone has to be added", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of Companies associated with the Zone", "schema": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "zones", "companies", "adminRight" ], "description": "Removes a Zone from Companies", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "body", "name": "Companies", "description": "Companies from which the Zone has to be removed", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "204": { "description": "Companies has been removed from Zone" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/zones/{zoneId}/devices": { "put": { "tags": [ "zones", "devices", "adminRight" ], "description": "Adds Devices to the Zone", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "body", "name": "Devices", "description": "Devices to be added to the Zone", "required": true, "schema": { "$ref": "#/definitions/baseListIdInt" } } ], "responses": { "200": { "description": "The list of Devices associated with the Zone", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/zones/{zoneId}/devices/{deviceId}": { "delete": { "tags": [ "zones", "devices", "adminRight" ], "description": "Removes Devices from the Zone", "parameters": [ { "in": "path", "name": "zoneId", "description": "ID of the Zone", "required": true, "type": "string" }, { "in": "path", "name": "deviceId", "description": "ID of the Device to be removed from the zone", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The list of Devices associated with the Zone", "schema": { "type": "array", "items": { "$ref": "#/definitions/Device" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/setting": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the AntiPassback setting", "responses": { "200": { "description": "The AntiPassback setting", "schema": { "$ref": "#/definitions/AntiPassbackSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "antiPassback", "adminRight" ], "description": "Updates the AntiPassback setting", "parameters": [ { "in": "body", "name": "AntiPassbackSetting", "description": "The AntiPassback setting object to do update by", "required": true, "schema": { "$ref": "#/definitions/AntiPassbackSetting" } } ], "responses": { "200": { "description": "The AntiPassback setting", "schema": { "$ref": "#/definitions/AntiPassbackSetting" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns a list of AntiPassback Areas", "responses": { "200": { "description": "The list of AntiPassback Areas", "schema": { "type": "array", "items": { "$ref": "#/definitions/Area" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "antiPassback", "adminRight" ], "description": "Creates a new AntiPassback Area", "parameters": [ { "in": "body", "name": "Area", "description": "The object to create the AntiPassback Area from (Name and Direction only)", "required": true, "schema": { "$ref": "#/definitions/Area" } } ], "responses": { "200": { "description": "The detail of the created AntiPassback Area", "schema": { "$ref": "#/definitions/Area" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas/{areaId}": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" } ], "responses": { "200": { "description": "The AntiPassback Area", "schema": { "$ref": "#/definitions/Area" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "antiPassback", "adminRight" ], "description": "Updates the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "body", "name": "Area", "description": "The AntiPassback Area object to update by", "required": true, "schema": { "$ref": "#/definitions/Area" } } ], "responses": { "200": { "description": "The AntiPassback Area", "schema": { "$ref": "#/definitions/Area" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "antiPassback", "adminRight" ], "description": "Deletes the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "body", "name": "Area", "description": "The AntiPassback Area (ModifiedGuid required)", "required": true, "schema": { "$ref": "#/definitions/Area" } } ], "responses": { "204": { "description": "The AntiPassback Area has been deleted" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/devices": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns a list of Access Devices", "responses": { "200": { "description": "The list of Access Devices", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessDevice" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas/{areaId}/devices": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the Access Device list of the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Access Device list of the AntiPassback Area", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessDevice" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "antiPassback", "adminRight" ], "description": "Add Access Devices to the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "body", "name": "AccessDevices", "description": "The list of Access Devices to be added to the AntiPassback Area", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The Access Device list of the AntiPassback Area", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessDevice" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "antiPassback", "adminRight" ], "description": "Remove Access Devices from the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "body", "name": "AccessDevices", "description": "The list of Access Devices to be removed from the AntiPassback Area", "required": true, "schema": { "$ref": "#/definitions/baseListId" } } ], "responses": { "200": { "description": "The Access Device list of the AntiPassback Area", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccessDevice" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas/{areaId}/devices/{deviceId}": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the Access Device of the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "path", "name": "deviceId", "description": "ID of the Access Device", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The Access Device of the AntiPassback Area", "schema": { "$ref": "#/definitions/AccessDevice" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "antiPassback", "adminRight" ], "description": "Updates the Access Device of the AntiPassback Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "path", "name": "deviceId", "description": "ID of the Access Device", "required": true, "type": "integer" }, { "in": "body", "name": "AccessDevice", "required": true, "description": "The object to modify the Access Device by", "schema": { "$ref": "#/definitions/AccessDevice" } } ], "responses": { "200": { "description": "The Access Device of the AntiPassback Area", "schema": { "$ref": "#/definitions/AccessDevice" } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/excluded": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the list of Groups and Users excluded from AntiPassback mechanism", "responses": { "200": { "description": "The list of Groups and Users excluded from AntiPassback mechanism", "schema": { "type": "array", "items": { "$ref": "#/definitions/Excluded" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "antiPassback", "adminRight" ], "description": "Exclude items (Groups, Users) from AntiPassback mechanism", "parameters": [ { "in": "body", "name": "Excluded items (Groups, Users)", "description": "The list of Groups and Users to be added to exclusion", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Excluded" } } } ], "responses": { "200": { "description": "The list of Groups and Users excluded from AntiPassback mechanism", "schema": { "type": "array", "items": { "$ref": "#/definitions/Excluded" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "antiPassback", "adminRight" ], "description": "Remove items (Groups, Users) from exclusion from AntiPassback mechanism", "parameters": [ { "in": "body", "name": "Excluded items (Groups, Users)", "description": "The list of Groups and Users to be removed from exclusion", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Excluded" } } } ], "responses": { "200": { "description": "The list of Groups and Users excluded from AntiPassback mechanism", "schema": { "type": "array", "items": { "$ref": "#/definitions/Excluded" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas/{areaId}/blocked": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the list of blocked Users of the Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of blocked Users of the Area", "schema": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "antiPassback", "adminRight" ], "description": "Removes Users from the list of blocked Users of the Area", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" }, { "in": "body", "name": "Area", "description": "The list of blocked Users of the Area to remove", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/idObject" } } } ], "responses": { "200": { "description": "The list of blocked Users of the Area", "schema": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/resets": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the AntiPassback Reset objects", "responses": { "200": { "description": "The list of AntiPassback Reset objects", "schema": { "type": "array", "items": { "$ref": "#/definitions/Reset" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "tags": [ "antiPassback", "adminRight" ], "description": "Updates AntiPassback Resets (Insert, Update and Delete at once)", "parameters": [ { "in": "body", "name": "Resets", "description": "The AntiPassback Reset object list to do update by", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Reset" } } } ], "responses": { "200": { "description": "The AntiPassback Reset object list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Reset" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/antipassback/areas/{areaId}/issues": { "get": { "tags": [ "antiPassback", "adminRight" ], "description": "Returns the AntiPassback Area issues", "parameters": [ { "in": "path", "name": "areaId", "description": "ID of the AntiPassback Area", "required": true, "type": "string" } ], "responses": { "200": { "description": "The AntiPassback Area issues", "schema": { "type": "array", "items": { "$ref": "#/definitions/AreaIssue" } } }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/search": { "get": { "tags": [ "search" ], "description": "Search", "parameters": [ { "in": "query", "name": "query", "type": "string", "required": true, "description": "query=String-to-be-searched-for" } ], "responses": { "200": { "description": "Search result", "schema": { "$ref": "#/definitions/SearchResult" } } } } }, "/search/suggestions": { "get": { "tags": [ "search" ], "description": "Search", "parameters": [ { "in": "query", "name": "query", "type": "string", "required": true, "description": "query=String-to-be-searched-for" } ], "responses": { "200": { "description": "Search result", "schema": { "$ref": "#/definitions/SearchSuggestionsResult" } } } } }, "/search/suggestions/accesslog": { "get": { "tags": [ "search" ], "description": "Search", "parameters": [ { "in": "query", "name": "query", "type": "string", "required": true, "description": "query=String-to-be-searched-for" } ], "responses": { "200": { "description": "Search result", "schema": { "type": "object", "properties": { "devices": { "$ref": "#/definitions/SearchSuggestionsResultObjectInt" }, "users": { "$ref": "#/definitions/SearchSuggestionsResultObject" }, "visitorCards": { "$ref": "#/definitions/SearchSuggestionsResultObject" }, "zones": { "$ref": "#/definitions/SearchSuggestionsResultObject" }, "companies": { "$ref": "#/definitions/SearchSuggestionsResultObjectInt" } } } } } } }, "/search/suggestions/systemlog": { "get": { "tags": [ "search" ], "description": "Search", "parameters": [ { "in": "query", "name": "query", "type": "string", "required": true, "description": "query=String-to-be-searched-for" } ], "responses": { "200": { "description": "Search result", "schema": { "type": "object", "properties": { "subjects": { "type": "array", "items": { "$ref": "#/definitions/SysLogSuggestionResult" } } } } } } } }, "/lockdown/activate": { "put": { "tags": [ "lockdown" ], "description": "Activation of the lockdown", "parameters": [ { "in": "body", "name": "LockdownActivationModel", "description": "The list of entities to activate lockdown on", "required": true, "schema": { "$ref": "#/definitions/LockdownActivationModel" } } ], "responses": { "204": { "description": "Activation of the lockdown successful" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/lockdown/deactivate": { "put": { "tags": [ "lockdown" ], "description": "Deactivation of the lockdown", "parameters": [ { "in": "body", "name": "LockdownActivationModel", "description": "The list of entities to deactivate lockdown on", "required": true, "schema": { "$ref": "#/definitions/LockdownActivationModel" } } ], "responses": { "204": { "description": "Deactivation of the lockdown successful" }, "default": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } } }, "definitions": { "deletionObject": { "type": "object", "properties": { "ModifiedGuid": { "type": "integer" } } }, "baseObject": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "baseObjectInt": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "idNameObject": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" } } }, "idNameObjectInt": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" } } }, "idObject": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" } } }, "idObjectInt": { "type": "object", "properties": { "Id": { "type": "integer" } } }, "basePOST": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of a new entity" } } }, "basePOSTwithCompany": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of a new entity" }, "Company": { "$ref": "#/definitions/idObjectInt" } } }, "baseListId": { "type": "array", "items": { "properties": { "Id": { "$ref": "#/definitions/UUID" } } } }, "baseListIdInt": { "type": "array", "items": { "properties": { "Id": { "type": "integer" } } } }, "baseState": { "type": "object", "properties": { "When": { "type": "string", "format": "date-time" }, "State": { "type": "integer", "enum": [ "Unknown = 0", "InProgress = 1", "Successful = 2", "Failed = 3", "Incompatible = 4" ] } } }, "Error": { "required": [ "ACErrorCode", "Message" ], "properties": { "ACErrorCode": { "type": "string" }, "Message": { "type": "string" } } }, "simpleDevice": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "IPAddress": { "type": "string" }, "SerialNumber": { "type": "string" } } }, "UUID": { "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "AccessRule": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "description": "the name is read only", "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Group": { "$ref": "#/definitions/idNameObject" }, "Zone": { "$ref": "#/definitions/idNameObject" }, "TimeProfile": { "$ref": "#/definitions/idNameObject" } } }, "BulkAccessRules": { "type": "object", "properties": { "GroupIds": { "type": "array", "items": { "$ref": "#/definitions/UUID" } }, "ZoneIds": { "type": "array", "items": { "$ref": "#/definitions/UUID" } }, "TimeProfileId": { "$ref": "#/definitions/UUID" } } }, "CommonSetting": { "type": "object", "properties": { "Id": { "type": "integer" }, "Localization": { "$ref": "#/definitions/idObjectInt" }, "Company": { "$ref": "#/definitions/idObjectInt" }, "WeekViewMode": { "type": "integer" }, "FirstDayOfWeek": { "type": "string" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "Company": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "CommonSetting": { "$ref": "#/definitions/CommonSetting" }, "AttendanceSetting": { "$ref": "#/definitions/AttendanceSetting" }, "Zones": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } }, "Customer": { "$ref": "#/definitions/baseObject" }, "Holidays": { "type": "array", "items": { "$ref": "#/definitions/Holiday" } }, "LdapSettings": { "type": "array", "items": { "$ref": "#/definitions/LdapSettings" } }, "LdapEnabled": { "type": "boolean" }, "Lockdown": { "$ref": "#/definitions/LockdownState" }, "Devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceInCompany" } } } }, "DeviceInCompany": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Status": { "type": "integer", "enum": [ "Unknown = 0", "Inaccessible = 2", "LoginFailed = 3", "Active = 4", "Disabled = 5", "Incompatible =6" ] } } }, "Holiday": { "type": "object", "properties": { "Company": { "$ref": "#/definitions/idObjectInt" }, "Id": { "type": "integer" }, "Localization": { "$ref": "#/definitions/idObjectInt" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Name": { "type": "string" }, "ValidFrom": { "description": "date time with time zone e.g.: \"2019-01-01T01:00:00+01:00\"", "type": "string", "format": "date-time" }, "ValidTo": { "description": "date time with time zone e.g.: \"2020-01-01T01:00:00+01:00\"", "type": "string", "format": "date-time" }, "IsRepeatable": { "type": "boolean" }, "Date": { "description": "the date e.g.: \"2019-05-01\"", "type": "string", "format": "date" } } }, "AttendanceSetting": { "type": "object", "properties": { "Id": { "type": "integer" }, "Company": { "$ref": "#/definitions/idObjectInt" }, "DayFrom": { "description": "the time e.g.:\"08:00:00\"", "type": "string", "format": "time" }, "DayTo": { "description": "the time e.g.:\"16:00:00\"", "type": "string", "format": "time" }, "WorkingDays": { "type": "array", "items": { "$ref": "#/definitions/WorkingDay" } }, "WorkingHoursFrom": { "description": "the time e.g.:\"08:00:00\"", "type": "string", "format": "time" }, "WorkingHoursTo": { "description": "the time e.g.:\"16:00:00\"", "type": "string", "format": "time" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "WorkingDay": { "type": "object", "properties": { "Ordinal": { "type": "integer" }, "IsBusinessDay": { "type": "boolean" } } }, "Device": { "type": "object", "properties": { "ButtonCount": { "type": "integer" }, "Camera": { "type": "boolean" }, "KeyBoard": { "type": "integer" }, "Id": { "type": "integer" }, "Zone": { "$ref": "#/definitions/idNameObject" }, "Name": { "type": "string" }, "SerialNumber": { "type": "string" }, "MACAddress": { "type": "string" }, "IPAddress": { "type": "string", "format": "IPAddress" }, "Port": { "type": "number" }, "ProductName": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Login": { "type": "string" }, "Password": { "type": "string", "format": "password" }, "IsEnabled": { "type": "boolean" }, "Display": { "type": "boolean" }, "IsLicensedDevice": { "type": "boolean" }, "Status": { "type": "integer", "enum": [ "Unknown = 0", "Inaccessible = 2", "LoginFailed = 3", "Active = 4", "Disabled = 5", "Incompatible =6" ] }, "Buttons": { "type": "array", "items": { "$ref": "#/definitions/Button" } }, "Keypad": { "type": "array", "items": { "$ref": "#/definitions/Keypad" } }, "NameTags": { "$ref": "#/definitions/DisplayNameTags" }, "SoftwareVersion": { "type": "string" }, "IsSupportedFirmware": { "type": "boolean" }, "IsAllowedFirmware": { "type": "boolean" }, "UploadState": { "$ref": "#/definitions/baseState" }, "BackupState": { "$ref": "#/definitions/baseState" }, "RestoreState": { "$ref": "#/definitions/baseState" }, "HasBackup": { "type": "boolean" }, "LastBackup": { "$ref": "#/definitions/Backup" }, "Features": { "description": "Comma separated list of supported events", "type": "string" }, "HasAccessControl": { "type": "boolean" }, "IsInSystem": { "type": "boolean" }, "IsCardAuthentication": { "type": "boolean" }, "IsCodeAuthentication": { "type": "boolean" }, "IsFingerprintAuthentication": { "type": "boolean" }, "IsMobileKeyAuthentication": { "type": "boolean" }, "LiftModules": { "type": "array", "items": { "$ref": "#/definitions/LiftModule" } }, "IsAnsweringUnit": { "type": "boolean" }, "IsIndoorTouch": { "type": "boolean" }, "IsIndoorTouch2": { "type": "boolean" }, "HasLiftControl": { "type": "boolean" }, "HasHiSecFeatures": { "type": "boolean" }, "LiftFloors": { "type": "array", "items": { "$ref": "#/definitions/LiftFloor" } }, "IsFirmwareLocked": { "type": "boolean" }, "AttendanceEnabled": { "type": "boolean" }, "LiftEnabled": { "type": "boolean" }, "CamLogSupported": { "type": "boolean" }, "HasVirtualNumbers": { "type": "boolean" }, "Problems": { "type": "array", "items": { "$ref": "#/definitions/DeviceProblem" } }, "Lockdown": { "$ref": "#/definitions/DeviceLockdownState" }, "DoorSwitch": { "type": "integer" } } }, "DeviceProblem": { "type": "object", "properties": { "Type": { "type": "integer", "enum": [ "LiftLicenseLost", "LiftModuleDisabled", "LiftModuleDisconnected", "FirmwareUpdateFailed", "FirmwareUpdateRetriesFailed", "MaximumParallelCallReached", "MaximumTreePathReached", "Other = 100" ] }, "AdditionalInfo": { "type": "string" }, "UserId": { "$ref": "#/definitions/UUID" } } }, "LockdownState": { "type": "object", "properties": { "State": { "type": "integer", "enum": [ "Unknown = 0,", "Normal = 1,", "Lockdown = 2,", "PartialLockdown = 3" ] } } }, "DeviceLockdownState": { "type": "object", "properties": { "State": { "type": "integer", "enum": [ "Unknown = 0,", "Normal = 1,", "Lockdown = 2,", "PartialLockdown = 3" ] }, "Confirmed": { "type": "boolean" } } }, "DevicePassword": { "type": "object", "properties": { "Password": { "type": "string", "format": "password" } } }, "Button": { "type": "object", "properties": { "Button": { "type": "integer" }, "Users": { "type": "array", "items": { "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string", "description": "User name" } } } } } }, "DisplayButton": { "type": "object", "properties": { "Id": { "type": "integer" }, "Ordinal": { "type": "integer" }, "User": { "$ref": "#/definitions/idNameObject" }, "ModifiedGuid": { "type": "integer" } } }, "DisplayNode": { "type": "object", "description": "HIP Phonebook node", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Type": { "type": "string", "enum": [ "User", "Group", "CallGroup", "Folder" ] }, "Priority": { "type": "integer" }, "IsCallGroup": { "type": "boolean" }, "Nodes": { "type": "array", "items": { "$ref": "#/definitions/DisplayNode" } } } }, "DisplayPhonebook": { "type": "object", "description": "HIP Phonebook - see the definition", "properties": { "Nodes": { "type": "array", "items": { "$ref": "#/definitions/DisplayNode" } } } }, "DisplayNameTags": { "type": "array", "items": { "$ref": "#/definitions/DisplayButton" } }, "Keypad": { "type": "object", "properties": { "Id": { "type": "integer" }, "User": { "$ref": "#/definitions/idNameObject" }, "VirtualNumber": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "Backup": { "type": "object", "properties": { "Id": { "type": "integer" }, "SoftwareVersion": { "type": "string" }, "Modified": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "DeviceStatus": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "SerialNumber": { "type": "string" }, "MACAddress": { "type": "string" }, "IPAddress": { "type": "string", "format": "IPAddress" }, "SoftwareVersion": { "type": "string" }, "IsOnline": { "type": "boolean" }, "Status": { "type": "integer" }, "IsLicensedDevice": { "type": "boolean" }, "AudioLoopTest": { "$ref": "#/definitions/AudioLoopTestStatus" }, "Door": { "$ref": "#/definitions/DoorStatus" }, "Sip1": { "$ref": "#/definitions/SipStatus" }, "Sip2": { "$ref": "#/definitions/SipStatus" }, "TamperSwitch": { "$ref": "#/definitions/TamperSwitchStatus" }, "Out": { "$ref": "#/definitions/OutStatus" }, "UpTime": { "type": "integer" }, "LiftModules": { "type": "array", "items": { "$ref": "#/definitions/LiftModule" } } } }, "AudioLoopTestStatus": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "passed = 0", "no = 1", "failed = 2", "unknown = 3" ] }, "Time": { "type": "string" } } }, "DoorStatus": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "closed = 0", "opened = 1", "open too long = 2", "unauthorized = 3", "unknown = 4" ] }, "Time": { "type": "string" } } }, "SipStatus": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "unregistered = 0", "registering = 1", "registered = 2", "error = 3", "unknown = 4" ] }, "Time": { "type": "string" }, "FailureReason": { "type": "string" } } }, "TamperSwitchStatus": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "out = 0", "in = 1", "unknown = 2" ] }, "Time": { "type": "string" } } }, "OutStatus": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "false = 0", "true = 1" ] }, "Time": { "type": "string" } } }, "SwitchAction": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "on", "off", "trigger" ] } } }, "SwitchSettings": { "type": "object", "properties": { "switch": { "type": "integer" }, "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "switchOnDuration": { "type": "integer" }, "type": { "type": "string" } } }, "MonitorSettings": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/MonitorSettingsColumnItem" } }, "hiddenDevices": { "type": "array", "items": { "$ref": "#/definitions/idObjectInt" } } } }, "MonitorSettingsColumnItem": { "type": "object", "properties": { "Value": { "type": "integer" } } }, "Group": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Company": { "$ref": "#/definitions/idNameObjectInt" }, "Name": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Users": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } }, "VisitorCards": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } }, "CompanyName": { "type": "string" }, "UserCount": { "type": "integer" } } }, "LoginInfo": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Login": { "type": "string" }, "Email": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Localization": { "type": "integer" }, "ShowWizard": { "type": "boolean" }, "IsAttendanceMonitoring": { "type": "boolean" }, "Right": { "$ref": "#/definitions/Right" } } }, "PasswordResetData": { "type": "object", "properties": { "Login": { "type": "string" } } }, "PasswordResetCodeData": { "type": "object", "properties": { "Code": { "type": "string" } } }, "PasswordResetTokenData": { "type": "object", "properties": { "Token": { "type": "string" } } }, "SetNewPasswordData": { "type": "object", "properties": { "Token": { "type": "string" }, "NewPassword": { "type": "string" } } }, "DashboardInfo": { "type": "object", "properties": { "Companies": { "type": "integer" }, "Users": { "type": "integer" }, "PresentUsers": { "type": "integer" }, "Groups": { "type": "integer" }, "Zones": { "type": "integer" }, "DevicesOnline": { "type": "integer" }, "DevicesLoginFailed": { "type": "integer" }, "DevicesOffline": { "type": "integer" }, "TimeProfiles": { "type": "integer" }, "AccessRules": { "type": "integer" }, "MonitoredUsers": { "type": "integer" }, "MyCurrentlyMonitoredUsers": { "type": "integer" }, "CurrentlyMonitoredUsers": { "type": "integer" }, "MaxDevices": { "type": "integer" }, "MaxUsers": { "type": "integer" } } }, "Snapshot": { "type": "object", "properties": { "Timestamp": { "type": "string" }, "ImageUrl": { "type": "string" } } }, "AttendanceMode": { "type": "object", "properties": { "IsAttendanceSpecifyingDirection": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "AttendanceLog": { "type": "object", "properties": { "Category": { "$ref": "#/definitions/AccessCategory" }, "Time": { "type": "string", "format": "date-time" }, "DeviceTime": { "type": "string", "format": "date-time" }, "Person": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Email": { "type": "string" }, "PhoneNumber": { "type": "string" }, "CurrentName": { "type": "string" }, "CompanyName": { "type": "string" }, "IsDeleted": { "type": "boolean" }, "IsVisitorCard": { "type": "boolean" } } }, "Device": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Host": { "type": "string" }, "SerialNumber": { "type": "string" }, "IsDeleted": { "type": "boolean" } } }, "Zone": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "IsDeleted": { "type": "boolean" } } }, "Credentials": { "type": "object", "properties": { "Pin": { "$ref": "#/definitions/Credential" }, "Card": { "$ref": "#/definitions/Credential" }, "FingerPrint": { "$ref": "#/definitions/Credential" }, "Rex": { "$ref": "#/definitions/Credential" }, "Bluetooth": { "$ref": "#/definitions/Credential" }, "Remote": { "$ref": "#/definitions/Credential" }, "Credentials": { "type": "string" } } }, "Detail": { "type": "string" }, "Snapshot": { "type": "object", "properties": { "IsAvailable": { "type": "boolean" }, "Timestamp": { "type": "integer" } } }, "Direction": { "type": "string", "enum": [ "Entry", "Exit", "Unknown" ] } } }, "AccessCategory": { "type": "string", "enum": [ "Unknown", "Granted", "Denied", "Public", "Lockout" ] }, "Credential": { "type": "string", "enum": [ "unused", "valid", "invalid" ] }, "License": { "type": "object", "properties": { "LicenseDeviceSN": { "type": "string" }, "LicenseTier": { "type": "string", "enum": [ "Trial", "Basic", "Advanced", "Pro", "Unlimited" ] }, "Expiration": { "type": "string" }, "AvailableUsers": { "type": "integer" }, "MaxUsers": { "type": "integer" }, "AvailableDevices": { "type": "integer" }, "MaxDevices": { "type": "integer" }, "AvailableManagers": { "type": "integer" }, "MaxManagers": { "type": "integer" }, "Uploaded": { "type": "string" }, "HasAttendance": { "type": "boolean" } } }, "LicenseFeatures": { "type": "object", "properties": { "Tier": { "type": "string", "enum": [ "Trial", "Basic", "Advanced", "Pro", "Unlimited" ] }, "Notifications": { "type": "boolean" }, "UserRoles": { "type": "boolean" }, "Presence": { "type": "boolean" }, "UserLimit": { "type": "integer" }, "DeviceLimit": { "type": "integer" }, "ManagerLimit": { "type": "integer" }, "Synchronization": { "type": "boolean" }, "Attendance": { "type": "boolean" }, "FirmwareUpdate": { "type": "boolean" }, "PersonalizedDashboard": { "type": "boolean" } } }, "SystemLog": { "type": "object", "properties": { "Category": { "type": "integer", "enum": [ "DeviceState", "Import", "UserSynchronization", "System", "UserAction" ] }, "Time": { "type": "string" }, "Severity": { "type": "integer", "enum": [ "Info = 0", "Warn = 1", "Error = 2" ] }, "Subject": { "type": "object", "properties": { "Type": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" } } }, "Event": { "type": "string" }, "Detail": { "type": "string" }, "Snapshot": { "type": "object", "properties": { "IsAvailable": { "type": "boolean" }, "Timestamp": { "type": "integer" } } } } }, "LicenseAgreementModification": { "type": "object", "properties": { "ShowLicenseAgreement": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "UpdateSetting": { "type": "object", "properties": { "Beta": { "type": "boolean" }, "Enabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "UpgradeHostSetting": { "type": "object", "properties": { "Host": { "type": "string" } } }, "SystemUpdate": { "type": "object", "properties": { "Status": { "type": "integer", "enum": [ "UpToDate = 0", "UpdateAvailable = 1", "ServerUnavailable = 2", "Downloading = 3", "ReadyToUpdate = 4", "Updating = 5", "UpdateError = 6" ] }, "Date": { "type": "string" }, "Version": { "type": "string" }, "ReleaseNotes": { "type": "array", "items": { "type": "string" } }, "Progress": { "type": "integer" } } }, "Smtp": { "type": "object", "properties": { "DefaultAddressFrom": { "type": "string", "format": "email" }, "Enabled": { "type": "boolean" }, "Host": { "type": "string" }, "HostPassword": { "type": "string", "format": "password" }, "HostUserName": { "type": "string" }, "Port": { "type": "integer" }, "Ssl": { "type": "boolean" }, "UseLegacyMode": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "HttpSettings": { "type": "object", "properties": { "BaseAddress": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "MobileKeyCompany": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Devices": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } } } }, "MobileKeysItem": { "type": "object", "properties": { "Ordinal": { "type": "integer" }, "Modified": { "description": "The date and time of the creation", "type": "string", "format": "date-time" }, "KeyId": { "type": "string" } } }, "MobileKeys": { "type": "array", "items": { "$ref": "#/definitions/MobileKeysItem" } }, "MobileKey": { "type": "object", "properties": { "ValidityPeriod": { "type": "integer" }, "UseDongle": { "type": "boolean" }, "Companies": { "type": "array", "items": { "$ref": "#/definitions/MobileKeyCompany" } }, "Keys": { "$ref": "#/definitions/MobileKeys" } } }, "SystemInfo": { "type": "object", "properties": { "DateTime": { "type": "object", "properties": { "Utc": { "type": "string" }, "Local": { "type": "string" }, "UtcOffset": { "type": "string" } } } } }, "TimeProfile": { "type": "object", "properties": { "Intervals": { "type": "array", "items": { "$ref": "#/definitions/Interval" } }, "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Modified": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Ordinal": { "type": "integer" }, "Days": { "type": "array", "items": { "$ref": "#/definitions/Day" } } } }, "Day": { "type": "object", "properties": { "DayOfWeek": { "type": "integer" }, "Enabled": { "type": "boolean" }, "Intervals": { "type": "array", "items": { "$ref": "#/definitions/Interval" } }, "TimeProfile": { "$ref": "#/definitions/idObject" } } }, "Interval": { "type": "object", "properties": { "DayOfWeek": { "type": "integer" }, "Enabled": { "type": "boolean" }, "From": { "type": "string", "format": "time" }, "To": { "type": "string", "format": "time" }, "Id": { "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "UserAttendanceDetail": { "type": "object", "properties": { "Days": { "type": "array", "items": { "$ref": "#/definitions/UserAttendanceDay" } }, "Balance": { "$ref": "#/definitions/HoursAndMinutes" }, "PeriodHours": { "$ref": "#/definitions/HoursAndMinutes" }, "WorkedHours": { "$ref": "#/definitions/HoursAndMinutes" }, "WorkingHours": { "$ref": "#/definitions/HoursAndMinutes" } } }, "UserAttendanceDay": { "type": "object", "properties": { "Appointments": { "type": "array", "items": { "$ref": "#/definitions/Appointment" } } } }, "HoursAndMinutes": { "type": "string", "description": "Hours and minutes with sign e.g. \"-178:30\" or \"0:15\"" }, "Appointment": { "type": "object", "properties": { "Order": { "type": "integer" }, "Id": { "type": "integer" }, "Date": { "type": "string", "format": "date" }, "DayBalance": { "type": "number" }, "From": { "type": "string", "format": "time" }, "To": { "type": "string", "format": "time" }, "Hours": { "type": "number" }, "Subject": { "type": "string" }, "Holiday": { "type": "boolean" }, "IsEdited": { "type": "boolean" }, "IsAllDayEvent": { "type": "boolean" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "BaseCard": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Identification": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "Card": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Identification": { "type": "string" }, "Description": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "MobileKeyUser": { "type": "object", "properties": { "AuthId": { "type": "string" }, "Pairing": { "$ref": "#/definitions/MobileKeyPairingState" }, "Settings": { "$ref": "#/definitions/MobileKeyUserSettings" } } }, "MobileKeyUserSettings": { "type": "object", "properties": { "AvailableDevices": { "type": "array", "items": { "$ref": "#/definitions/baseObjectInt" } }, "ValidityPeriod": { "type": "integer" }, "UseDongle": { "type": "boolean", "description": "Pairing via USB dongle is allowed" } } }, "MobileKeyPairingState": { "type": "object", "properties": { "PairingTimeUntil": { "type": "string" }, "PairingType": { "type": "string", "description": "Pairing BT type", "enum": [ "device", "dongle" ] }, "Pin": { "type": "string" }, "State": { "type": "string", "description": "Pairing BT state: unknown, inactive, pending, expired, paired" } } }, "MobileKeyPairingSetObject": { "type": "object", "properties": { "state": { "type": "string", "description": "If it is \"paired\", then \"authId\" is updated" }, "authId": { "type": "string", "description": "\"authId\" to update" } } }, "MobileKeyDonglePairingData": { "type": "object", "properties": { "Pin": { "type": "integer" }, "Location": { "type": "string" }, "KeyId": { "type": "string" }, "PubKey": { "type": "string" }, "AuthId": { "type": "string" } } }, "Emails": { "description": "The array of email adresses", "type": "array", "items": { "type": "object", "properties": { "Email": { "type": "string" } } } }, "Code": { "type": "object", "properties": { "Id": { "type": "integer" }, "ModifiedGuid": { "type": "integer" }, "Ordinal": { "type": "integer" }, "SwitchCode": { "type": "string" }, "Collisions": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "Fingerprint": { "type": "object", "properties": { "Id": { "type": "integer" }, "Position": { "type": "integer" }, "Template": { "type": "string" }, "IsOpenDoor": { "type": "boolean" }, "IsSilentAlarm": { "type": "boolean" }, "IsAutomationFunction1": { "type": "boolean" }, "IsAutomationFunction2": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "User": { "type": "object", "properties": { "Company": { "$ref": "#/definitions/idNameObjectInt" }, "Right": { "$ref": "#/definitions/Right" }, "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Email": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Login": { "type": "string" }, "AvatarUrl": { "type": "string" }, "IsAttendanceMonitoring": { "type": "boolean" }, "VirtualNumber": { "type": "string" }, "EmployeeID": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } }, "GroupNames": { "type": "string" }, "Cards": { "type": "array", "items": { "$ref": "#/definitions/BaseCard" } }, "MobileKey": { "type": "string" }, "PhoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/PhoneNumber" } }, "Codes": { "type": "array", "items": { "$ref": "#/definitions/Code" } }, "Settings": { "$ref": "#/definitions/UserSettings" }, "RestrictedAccess": { "$ref": "#/definitions/RestrictedAccess" }, "Fingerprints": { "type": "array", "items": { "$ref": "#/definitions/Fingerprint" } }, "Deputy": { "$ref": "#/definitions/idNameObject" }, "ValidFrom": { "type": "string", "format": "time" }, "ValidTo": { "type": "string", "format": "time" }, "Owner": { "type": "string" }, "CompanyName": { "type": "string" }, "PhoneNumberList": { "type": "string" }, "VirtualCard": { "type": "string" }, "Pin": { "type": "string" }, "PinCollisions": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } }, "IsCallable": { "type": "boolean" }, "Zones": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "UserForBulkRestrictedAccess": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "ModifiedGuid": { "type": "integer" }, "RestrictedAccess": { "$ref": "#/definitions/RestrictedAccess" } } }, "UserForBulkAttendanceMonitoring": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "ModifiedGuid": { "type": "integer" }, "IsAttendanceMonitoring": { "type": "boolean" } } }, "UserOld": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Company": { "$ref": "#/definitions/baseObjectInt" }, "Role": { "$ref": "#/definitions/idObjectInt" }, "Login": { "type": "string" }, "Name": { "type": "string" }, "Email": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "IsAttendanceMonitoring": { "type": "boolean" }, "VirtualNumber": { "type": "string" }, "EmployeeID": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/baseObject" } }, "Cards": { "type": "array", "items": { "$ref": "#/definitions/CardOld" } }, "PhoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/PhoneNumberOld" } }, "Codes": { "type": "array", "items": { "$ref": "#/definitions/CodeOld" } } } }, "CardOld": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "IsEnabled": { "type": "boolean" }, "Identification": { "type": "string" }, "Description": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "PhoneNumberOld": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Number": { "type": "string" }, "Ordinal": { "type": "integer" }, "GroupCall": { "type": "boolean" }, "StationName": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "CodeOld": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "SwitchCode": { "type": "string" }, "Ordinal": { "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "UserForUpdate": { "allOf": [ { "$ref": "#/definitions/User" }, { "type": "object", "properties": { "OldPassword": { "type": "string", "description": "Required on password change only" }, "Password": { "type": "string", "description": "Required on password change only" } } } ] }, "Presence": { "type": "object", "properties": { "Type": { "type": "string", "enum": [ "user", "visitorCard" ] }, "Present": { "$ref": "#/definitions/baseObject" }, "CompanyName": { "type": "string" }, "GroupNames": { "type": "string" }, "PhoneNumber": { "type": "string" }, "Email": { "type": "string" }, "LastSeen": { "$ref": "#/definitions/LastSeen" } } }, "LastSeen": { "type": "object", "properties": { "Time": { "type": "string" }, "DeviceName": { "type": "string" }, "ZoneName": { "type": "string" } } }, "UserSettings": { "type": "object", "properties": { "Id": { "type": "integer" }, "Localization": { "type": "integer", "enum": [ "Unknown = 0", "en-US = 1", "cs-CZ = 2", "de-DE = 3", "it-IT = 4", "ru-RU = 5", "es-ES = 6", "fr-FR = 7" ] }, "FromExternalSystem": { "type": "boolean" }, "PasswordMustBeChanged": { "type": "boolean" }, "ShowWizard": { "type": "boolean" }, "MonitorSettings": { "$ref": "#/definitions/MonitorSettings" }, "ReadersSettings": { "$ref": "#/definitions/UserReadersSettings" }, "ModifiedGuid": { "type": "integer" } } }, "VisitorCard": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Company": { "$ref": "#/definitions/idNameObjectInt" }, "Name": { "type": "string" }, "Identification": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "AvailableZones": { "$ref": "#/definitions/idNameObject" }, "Visitor": { "$ref": "#/definitions/Visitor" }, "Cards": { "type": "array", "items": { "$ref": "#/definitions/BaseCard" } }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "VisitorFrom": { "type": "object", "properties": { "FromNow": { "type": "boolean" }, "Date": { "type": "string", "format": "date" }, "Time": { "type": "string", "format": "time" } } }, "VisitorTo": { "type": "object", "properties": { "Interval": { "type": "integer" }, "UseInterval": { "type": "boolean" }, "Date": { "type": "string", "format": "date" }, "Time": { "type": "string", "format": "time" } } }, "Visitor": { "type": "object", "properties": { "From": { "$ref": "#/definitions/VisitorFrom" }, "To": { "$ref": "#/definitions/VisitorTo" }, "Exists": { "type": "boolean" }, "Id": { "type": "integer" }, "Name": { "type": "string" }, "Reason": { "type": "string" }, "User": { "$ref": "#/definitions/idObject" }, "ModifiedGuid": { "type": "integer" } } }, "RestrictedAccess": { "type": "object", "properties": { "FromDate": { "description": "the date part, e.g. \"2019-03-19\"", "type": "string", "format": "date" }, "FromTime": { "description": "the time part, e.g. \"09:30\"", "type": "string", "format": "time" }, "IsFromEnabled": { "type": "boolean" }, "ToDate": { "description": "the date part", "type": "string" }, "ToTime": { "description": "the time part", "type": "string" }, "IsToEnabled": { "type": "boolean" } } }, "RestrictedAccessData": { "type": "object", "properties": { "Id": { "type": "integer" }, "FromDate": { "description": "the date part, e.g. \"2019-03-19\"", "type": "string", "format": "date" }, "FromTime": { "description": "the time part, e.g. \"09:30\"", "type": "string", "format": "time" }, "IsFromEnabled": { "type": "boolean" }, "ToDate": { "description": "the date part", "type": "string" }, "ToTime": { "description": "the time part", "type": "string" }, "IsToEnabled": { "type": "boolean" }, "User": { "$ref": "#/definitions/idObject" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "Right": { "type": "object", "properties": { "IsAdmin": { "type": "boolean" }, "IsUserManager": { "type": "boolean" }, "IsAttendanceManager": { "type": "boolean" }, "IsAccessManager": { "type": "boolean" }, "IsSysAdmin": { "type": "boolean" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "PhoneNumber": { "type": "object", "properties": { "TimeProfile": { "$ref": "#/definitions/baseObject" }, "Ordinal": { "type": "integer" }, "Number": { "type": "string" }, "GroupCall": { "type": "boolean" }, "StationName": { "type": "string", "format": "IPAddress" }, "Id": { "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "Zone": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "ZonalCode": { "type": "string" }, "IsMobileKeyAuthentication": { "type": "boolean" }, "IsCardAuthentication": { "type": "boolean" }, "IsFingerprintAuthentication": { "type": "boolean" }, "IsCodeAuthentication": { "type": "boolean" }, "HasSilentAlarm": { "type": "boolean" }, "HasLimitFailedAccess": { "type": "boolean" }, "HasLicensePlateAuthentication": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" }, "Devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceInZone" } }, "Companies": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } }, "Problems": { "$ref": "#/definitions/ZoneProblem" }, "Lockdown": { "$ref": "#/definitions/LockdownState" }, "DeviceCount": { "type": "integer" } } }, "DeviceInZone": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "LiftEnabled": { "type": "boolean" }, "HasLiftControl": { "type": "boolean" }, "Status": { "type": "integer", "enum": [ "Unknown = 0", "Inaccessible = 2", "LoginFailed = 3", "Active = 4", "Disabled = 5", "Incompatible =6" ] }, "LiftFloors": { "type": "array", "items": { "$ref": "#/definitions/LiftFloor" } }, "IsLockdownable": { "type": "boolean" } } }, "NotificationUser": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Email": { "type": "string" } } }, "NotificationChannels": { "type": "object", "properties": { "AppBar": { "type": "boolean" }, "Email": { "type": "boolean" } } }, "NotificationEvents": { "type": "array", "items": { "$ref": "#/definitions/NotificationEvent" } }, "NotificationEvent": { "type": "string", "enum": [ "DeviceState", "AudioLoopTest", "SipProxyState", "TamperSwitch", "UnauthorizedDoorOpen", "DoorOpenTooLong", "LoginBlocked", "LicenseIssues", "CsvSyncFailure", "UnsupportedFirmware", "AntiPassbackAreaState", "AntiPassbackViolation", "SilentAlarm", "ThirdPartyUsersWithAccess", "DirectoryLimitExceeded", "LiftModuleState", "DiskUsageHigh", "AccessModuleLocked", "SystemUpdateAvailable", "FirmwareUpdateFailed", "LdapSyncFailure", "FirmwareUpdateAvailable" ] }, "NotificationRecipients": { "type": "object", "properties": { "External": { "type": "array", "description": "email addresses", "items": { "type": "string" } }, "Users": { "type": "array", "description": "users to be notified", "items": { "$ref": "#/definitions/NotificationUser" } } } }, "Recipients": { "type": "object", "properties": { "External": { "type": "array", "description": "email addresses", "items": { "type": "string" } }, "Users": { "type": "array", "description": "user ids", "items": { "$ref": "#/definitions/UUID" } } } }, "Notification": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Channels": { "$ref": "#/definitions/NotificationChannels" }, "Events": { "$ref": "#/definitions/NotificationEvents" }, "MonitorAllDevices": { "type": "boolean" }, "MonitoredDevices": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } }, "Recipients": { "$ref": "#/definitions/NotificationRecipients" }, "Users": { "type": "array", "items": { "$ref": "#/definitions/NotificationUser" } }, "ModifiedGuid": { "type": "integer" } } }, "SnapshotSetting": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Devices": { "type": "array", "items": { "$ref": "#/definitions/baseObjectInt" } }, "EventType": { "type": "string" }, "Modified": { "type": "string" }, "ModifiedBy": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "SnapshotStatistics": { "type": "object", "properties": { "Count": { "type": "integer" }, "Oldest": { "type": "string", "format": "date-time" } } }, "LdapSettings": { "type": "object", "properties": { "Id": { "type": "integer" }, "Host": { "type": "string" }, "Port": { "type": "integer" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "BaseDN": { "type": "string" }, "UseSSL": { "type": "boolean" }, "UserFilter": { "type": "string" }, "AssumeUserDisabling": { "type": "boolean" }, "RemovedSyncUsers": { "type": "integer", "enum": [ "Unchanged = 0", "Disabled = 1", "Deleted = 2" ] }, "FieldMapping": { "type": "object", "properties": { "UserIdAttribute": { "type": "string" }, "UserNameAttribute": { "type": "string" }, "UserLoginAttribute": { "type": "string" }, "EmailAttribute": { "type": "string" }, "EmployeeIdAttribute": { "type": "string" }, "PhoneNumbers1Attribute": { "type": "string" }, "PhoneNumbers2Attribute": { "type": "string" }, "PhoneNumbers3Attribute": { "type": "string" }, "PinCodeAttribute": { "type": "string" }, "CardNumber1Attribute": { "type": "string" }, "CardNumber2Attribute": { "type": "string" }, "AvatarAttribute": { "type": "string" } } }, "NestedSearch": { "type": "boolean" }, "ImportAvatar": { "type": "boolean" }, "SynchronizeFrom": { "type": "string" }, "LastSyncTime": { "type": "string" }, "LastSyncSuccess": { "type": "boolean" }, "PageSize": { "type": "integer" }, "ModifiedGuid": { "type": "integer" }, "Interval": { "type": "integer" }, "Enabled": { "type": "boolean" }, "DayOfWeek": { "type": "integer" } } }, "LdapStatus": { "type": "object", "properties": { "Id": { "type": "integer" }, "IsSynchronizing": { "type": "boolean" } } }, "RemoteStorage": { "type": "object", "properties": { "Address": { "description": "URL of CSV file on remote FTP server", "type": "string" }, "UserName": { "description": "User name to log-in to FTP server", "type": "string" }, "Password": { "description": "Password to log-in to FTP server (write only - void if read)", "type": "string" } } }, "AutomaticSync": { "type": "object", "properties": { "Enabled": { "description": "If the periodic synchronization is enabled", "type": "boolean" }, "From": { "description": "The date and time of the first periodic synchronization (if it is in the past - synchronize immediately)", "type": "string" }, "Interval": { "description": "The number of minutes between two consequent periodic synchronizations", "type": "integer" } } }, "SynchronizationSettings": { "type": "object", "properties": { "Address": { "description": "URL of CSV file on remote FTP server", "type": "string" }, "UserName": { "description": "User name to log-in to FTP server", "type": "string" }, "Password": { "description": "Password to log-in to FTP server (write only - void if read)", "type": "string" }, "Enabled": { "description": "If the periodic synchronization is enabled", "type": "boolean" }, "SynchronizeFrom": { "description": "Time when synchronization should happen", "type": "string" }, "Interval": { "description": "The number of minutes between two consequent periodic synchronizations", "type": "integer", "enum": [ "hour = 60", "day = 1440", "week = 10080" ] }, "DayOfWeek": { "description": "Day when synchronization should happen in case of week long period", "type": "integer", "enum": [ "sunday = 0", "monday = 1", "tuesday = 2", "wednesday = 3", "thursday = 4", "friday = 5", "saturady = 6" ] }, "ModifiedGuid": { "type": "integer" } } }, "SynchronizationStatus": { "type": "object", "properties": { "LastSyncTime": { "description": "The date and time of the last synchronization", "type": "string" }, "SyncState": { "description": "The status of the last synchronization", "type": "integer", "enum": [ "unknown = 0", "in progress = 1", "successful = 2", "failed = 3" ] }, "NextSyncTime": { "description": "The date and time of the next synchronization", "type": "string" } } }, "VerificationPair": { "type": "object", "properties": { "key": { "description": "Identificator of Subject to be verified", "type": "string" }, "verificationText": { "description": "The text representation of the Captcha", "type": "string" } } }, "VerificationKey": { "type": "object", "properties": { "key": { "description": "Identificator of the Subject to be verified", "type": "string" } } }, "VerificationObject": { "type": "object", "properties": { "verificationImage": { "description": "The image representation of the Captcha", "type": "string", "format": "binary" } } }, "Diagnostics": { "properties": { "DiagnosticStatus": { "type": "object", "properties": { "Status": { "description": "The stage of the process of creation of the diagnostic file", "type": "integer", "enum": [ "none = 0", "creating = 1", "exists = 2", "failed = 3" ] }, "Created": { "description": "The date and time of creation of the diagnostic file", "type": "string", "format": "date-time" } } } } }, "StatisticsStatus": { "type": "object", "properties": { "StatisticsEnabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "CameraLogs": { "type": "object", "properties": { "ImageDbMaxSize": { "description": "The max. size of disk space available to store CamLog data (in bytes)", "type": "integer" }, "ImageDbDeleteSize": { "description": "The size of disk space occupied by latest CamLog data after purge process (in bytes)", "type": "integer" } } }, "Compatibility": { "type": "object", "properties": { "ProductGroup": { "type": "string", "enum": [ "2N IP intercoms", "2N Access Unit", "2N IP Audio" ] }, "FwVersion": { "description": "The first two stages of firmware version number (2.21 for example)", "type": "string" }, "IsAccepted": { "description": "The flag indicating if the incompatibility has been accepted by admin", "type": "boolean" } } }, "ReadersSettings": { "type": "object", "properties": { "Rfid125kEnabled": { "description": "RFID 125kHz reader enabled", "type": "boolean" }, "Rfid13M56Enabled": { "description": "RFID 13.56MHz and 125kHz reader enabled", "type": "boolean" }, "FingerprintEnabled": { "description": "Fingerprint reader enabled", "type": "boolean" }, "BluetoothEnabled": { "description": "Bluetooth reader enabled", "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "UserReadersSettings": { "type": "object", "properties": { "selectedReader": { "type": "string", "enum": [ "Rfid125k", "Rfid13M56" ] } } }, "PresenceSettings": { "type": "object", "properties": { "HoursBack": { "description": "Number of hours back to watch the presence (1 to 24)", "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "SpaceUsage": { "type": "object", "properties": { "Latest": { "$ref": "#/definitions/SpaceUsageRecord" }, "History": { "type": "array", "items": { "$ref": "#/definitions/SpaceUsageRecord" } }, "OldestLog": { "$ref": "#/definitions/SpaceUsageOldestLog" }, "ShowUsageWaring": { "type": "boolean" } } }, "SpaceUsageRecord": { "description": "Space usage in given time", "type": "object", "properties": { "Timestamp": { "description": "Record time", "type": "string", "format": "time" }, "AccessLogs": { "type": "number" }, "SystemLogs": { "type": "number" }, "CamLogs": { "type": "number" }, "Total": { "type": "number" } } }, "SpaceUsageOldestLog": { "description": "Time of oldest record in database", "type": "object", "properties": { "AccessLogs": { "type": "string", "format": "time" }, "SystemLogs": { "type": "string", "format": "time" }, "CamLogs": { "type": "string", "format": "time" } } }, "LogLifetime": { "type": "object", "properties": { "AccessLog": { "description": "Current total used space on drive (bytes)", "$ref": "#/definitions/LogLifetimeSetting" }, "SystemLog": { "description": "Current total free space on drive (bytes)", "$ref": "#/definitions/LogLifetimeSetting" }, "CamLog": { "$ref": "#/definitions/LogLifetimeSetting" }, "ModifiedGuid": { "type": "integer" } } }, "LogLifetimeSetting": { "type": "object", "properties": { "MaximumRetention": { "type": "integer" }, "MinimumRetention": { "type": "integer" }, "PreservePriority": { "type": "integer" } } }, "Peripheries": { "type": "object", "properties": { "CardReader": { "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "SystemDevices": { "type": "object", "properties": { "EventDownloadsPeriod": { "type": "integer" }, "ModifiedGuid": { "type": "integer" } } }, "AntiPassbackSetting": { "type": "object", "properties": { "Mode": { "type": "integer", "enum": [ "Soft = 1", "Hard = 2" ] }, "Timeout": { "description": "in seconds (min. 10, max. 28800)", "type": "integer" }, "SendEmailToUser": { "type": "boolean" }, "ModifiedGuid": { "type": "integer" } } }, "Area": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Blocked": { "description": "Blocked users in the Area", "type": "array", "items": { "$ref": "#/definitions/baseObject" } }, "Customer": { "$ref": "#/definitions/idObject" }, "Devices": { "description": "Devices in the Area", "type": "array", "items": { "$ref": "#/definitions/AccessDevice" } }, "Direction": { "type": "integer", "enum": [ "Entry = 0", "Exit = 1", "Both = 2" ] }, "IsActive": { "type": "boolean" }, "IsEnabled": { "type": "boolean" }, "Issues": { "description": "Issues of the Area", "type": "array", "items": { "$ref": "#/definitions/AreaIssue" } }, "Name": { "type": "string" }, "ModifiedGuid": { "type": "integer" } } }, "AccessDevice": { "type": "object", "properties": { "Id": { "type": "integer" }, "APEntrance": { "type": "integer", "enum": [ "entrance on AP0 = 0", "entrance on AP1 = 1", "entrance on no AP = -1" ] }, "APExit": { "type": "integer", "enum": [ "exit on AP0 = 0", "exit on AP1 = 1", "exit on no AP = -1" ] }, "AP0Properties": { "$ref": "#/definitions/AccessPointDescription" }, "AP1Properties": { "$ref": "#/definitions/AccessPointDescription" }, "IPAddress": { "type": "string" }, "Name": { "type": "string" }, "SerialNumber": { "type": "string" }, "IsConfigured": { "type": "boolean" }, "HasAccessPoint": { "type": "boolean" } } }, "AccessPointDescription": { "description": "Description of readers on Access Point (e.g.: ['Card Reader (54-1216-0005)','Fingerprint Scanner (54-1829-0266)'])", "type": "array", "items": { "type": "string" } }, "Excluded": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "ModifiedGuid": { "type": "integer" }, "Type": { "type": "string", "enum": [ "User", "Group" ] } } }, "Reset": { "type": "object", "properties": { "ResetTime": { "type": "string", "format": "time" }, "DaysOfWeek": { "type": "string", "enum": [ "Monday = 0", "Tuesday = 1", "Wednesday = 2", "Thursday = 3", "Friday = 4", "Saturday = 5", "Sunday = 6" ] } } }, "AreaIssue": { "type": "object", "properties": { "Type": { "type": "integer", "enum": [ "NoDeviceInArea = 0", "NoDefinedInputOutput = 1", "DeviceIsMisconfigured = 2", "DeviceIsEnterOfAnotherArea = 3", "DeviceHasUnsufficientLicense = 4", "DeviceDisabled = 5", "DeviceDisconnected = 6", "DeviceHasIncompatibleVersion = 7", "DeviceHasRexButton = 8" ] }, "Device": { "$ref": "#/definitions/AreaIssueDevice" } } }, "AreaIssueDevice": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Areas": { "description": "Areas in collision with this Area over this Device", "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "ZoneProblem": { "type": "object", "properties": { "Type": { "type": "integer", "enum": [ "NoDeviceInZone", "DeviceDoesNotSupportedSilentAlarm", "DeviceHasNoSilentAlarmLicense", "PinCodeCollision", "DeviceDoesNotSupportedLimitFailedAccess", "DeviceHasNotLimitFailedAccessLicense", "Other = 100" ] }, "Devices": { "type": "array", "items": { "$ref": "#/definitions/idNameObjectInt" } }, "Users": { "type": "array", "items": { "$ref": "#/definitions/idNameObject" } } } }, "LabelValue": { "type": "object", "properties": { "Label": { "type": "string" }, "Value": { "type": "string" } } }, "LabelMatchValue": { "type": "object", "properties": { "Label": { "type": "string" }, "Match": { "type": "string" }, "Value": { "type": "string" } } }, "SearchSuggestionsResultObject": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Result": { "$ref": "#/definitions/LabelValue" } } }, "SearchSuggestionsResultObjectInt": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Result": { "$ref": "#/definitions/LabelValue" } } }, "SearchResultObject": { "type": "object", "properties": { "Id": { "$ref": "#/definitions/UUID" }, "Name": { "type": "string" }, "Result": { "$ref": "#/definitions/LabelMatchValue" } } }, "SearchResultObjectInt": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Result": { "$ref": "#/definitions/LabelMatchValue" } } }, "SysLogSuggestionResult": { "type": "object", "properties": { "Type": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" } } }, "SearchResult": { "type": "object", "properties": { "devicesCount": { "type": "integer" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/SearchResultObjectInt" } }, "groupsCount": { "type": "integer" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/SearchResultObject" } }, "usersCount": { "type": "integer" }, "users": { "type": "array", "items": { "$ref": "#/definitions/SearchResultObject" } }, "zonesCount": { "type": "integer" }, "zones": { "type": "array", "items": { "$ref": "#/definitions/SearchResultObject" } } } }, "SearchSuggestionsResult": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/SearchSuggestionsResultObjectInt" } }, "groups": { "type": "array", "items": { "$ref": "#/definitions/SearchSuggestionsResultObject" } }, "users": { "type": "array", "items": { "$ref": "#/definitions/SearchSuggestionsResultObject" } }, "zones": { "type": "array", "items": { "$ref": "#/definitions/SearchSuggestionsResultObject" } } } }, "LiftFloor": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "PublicAccess": { "type": "boolean" }, "PublicAccessProfile": { "$ref": "#/definitions/baseObject" }, "Zone": { "$ref": "#/definitions/baseObject" } } }, "LiftModule": { "type": "object", "properties": { "Id": { "type": "string" }, "Enabled": { "type": "boolean" }, "IpAddress": { "type": "string", "format": "IPAddress" }, "IsOnline": { "type": "boolean" }, "SerialNumber": { "type": "string" } } }, "FirmwareDeploymentStatus": { "type": "object", "properties": { "Id": { "type": "string" }, "ProductType": { "type": "string" }, "TotalDevices": { "type": "integer" }, "Candidate": { "$ref": "#/definitions/FirmwareCandidate" }, "Current": { "$ref": "#/definitions/CurrentFirmware" } } }, "FirmwareCandidate": { "type": "object", "properties": { "IsCompatible": { "type": "boolean" }, "IsAllowed": { "type": "boolean" }, "Version": { "type": "string", "format": "version" } } }, "CurrentFirmware": { "type": "object", "properties": { "Version": { "type": "string", "format": "version" }, "FailedUpdates": { "type": "integer" }, "PendingUpdates": { "type": "integer" }, "TotalUpdates": { "type": "integer" }, "IsCompatible": { "type": "boolean" }, "IsAllowed": { "type": "boolean" } } }, "DeviceUpdate": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Firmware": { "type": "array", "items": { "$ref": "#/definitions/FirmwareDeploymentStatus" } }, "ModifiedGuid": { "type": "integer" } } }, "PasswordPair": { "type": "object", "properties": { "OldPassword": { "type": "string" }, "NewPassword": { "type": "string" } } }, "OneTimePassword": { "type": "object", "properties": { "NewPassword": { "type": "string" } } }, "LockdownActivationModel": { "type": "object", "description": "ID of the entity to be (un)locked (others null) and the flag for global lockdown", "properties": { "DeviceId": { "type": "integer" }, "ZoneId": { "$ref": "#/definitions/UUID" }, "CompanyId": { "type": "integer" }, "Global": { "type": "boolean" } } } }, "parameters": { "accessLogCategoryParameter": { "in": "query", "name": "category", "required": false, "type": "string", "enum": [ "Unknown", "Granted", "Denied", "Public", "Lockout" ] }, "systemLogCategoryParameter": { "in": "query", "name": "category", "required": false, "type": "string", "enum": [ "DeviceState", "Import", "UserSynchronization", "System", "UserAction" ] }, "severityParameter": { "in": "query", "name": "severity", "required": false, "type": "string", "enum": [ "Info", "Warn", "Error" ] }, "authorIdParameter": { "in": "query", "name": "authorId", "required": false, "type": "string" }, "subjectParamater": { "in": "query", "name": "subject", "required": false, "type": "string" }, "fromParameter": { "in": "query", "name": "from", "required": false, "type": "string", "format": "date-time" }, "toParameter": { "in": "query", "name": "to", "required": false, "type": "string", "format": "date-time" }, "userIdParameter": { "in": "query", "name": "userId", "required": false, "type": "string" }, "deviceIdParameter": { "in": "query", "name": "deviceId", "required": false, "type": "integer" }, "zoneIdParameter": { "in": "query", "name": "zoneId", "required": false, "type": "string" }, "companyIdParameter": { "in": "query", "name": "companyId", "required": false, "type": "integer" }, "credentialsParameter": { "in": "query", "name": "credentials", "required": false, "type": "string", "enum": [ "pin", "card", "fingerprint", "bluetooth", "rex", "remote" ] }, "freeSearchParameter": { "in": "query", "name": "search", "required": false, "type": "string" }, "directionParameter": { "in": "query", "name": "direction", "required": false, "type": "string", "enum": [ "entry", "exit", "unknown" ] } } }