Временный доступ API 1.7.0
Методы API для работы с разделом «Временный доступ».
Базовый путь: https://{IP_контроллера}/api/v1.
Версия описания API: 1.7.0.
Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.
Методы раздела
GET /tmp_access
Раздел: Временный доступ.
Возвращает список всех добавленных разовых доступов с настройками
Назначение | URL запроса |
Возвращает список всех добавленных разовых доступов с настройками | https://{IP_контроллера}/api/v1/tmp_access |
Параметры запроса:
Отсутствуют
Варианты ответа:
Code 200 (Successfully got all temporary access) - удачное выполнение запроса
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ |
Пример:
[{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}]
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Returns all temporary access",
"parameters": [],
"responses": {
"200": {
"description": "Successfully got all temporary access",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/tmp_access" \
-H "Authorization: Bearer <token>"
Пример ответа
[
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
]
POST /tmp_access
Раздел: Временный доступ.
Добавляет новый разовый доступ
Назначение | URL запроса |
Добавляет новый разовый доступ | https://{IP_контроллера}/api/v1/tmp_access |
Параметры запроса:
Название | Тип | Описание | |
tmp_access* | object (body) | тело запроса | |
BODY | |||
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ | |
Пример:
URL запроса: POST
https://{IP_контроллера}/api/v1/
Body
{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}
Варианты ответа:
Code 201 (Successfully created new temporary access) - удачное выполнение запроса
Code 400 (Bad request parameters) - запрос не выполнен, указаны некорректные параметры запроса
Code 409 (Temporary access already exists) - запрос не выполнен, разовый доступ с указанным uuid уже существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Add new temporary access",
"requestBody": {
"description": "New temporary access properties",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Successfully created new temporary access"
},
"400": {
"description": "Bad request parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"409": {
"description": "Temporary access already exists",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X POST "https://{IP_контроллера}/api/v1/tmp_access" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}'
Пример тела запроса
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
GET /tmp_access/by_date/{date}
Раздел: Временный доступ.
Возвращает список всех разовых доступов за конкретную дату с настройками
Назначение | URL запроса |
Возвращает список всех разовых доступов за конкретную дату с настройками | https://{IP_контроллера}/api/v1/tmp_access/by_date/25.02.2022 |
Параметры запроса:
Наименование, * - обязательный | Описание |
date* string (path) | Дата доступа разового пропуска |
Варианты ответа:
Code 200 (Successfully got all temporary access) - удачное выполнение запроса
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ |
Пример:
[{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}]
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ сотрудника на указанную дату не существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Get specified temporary-access",
"parameters": [
{
"in": "path",
"name": "date",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully got all temporary access",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access was not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/tmp_access/by_date/{date}" \
-H "Authorization: Bearer <token>"
Пример ответа
[
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
]
GET /tmp_access/by_user/{user_uuid}
Раздел: Временный доступ.
Возвращает список всех разовых доступов для конкретного сотрудника по его uuid с настройками
Назначение | URL запроса |
Возвращает список всех разовых доступов для конкретного сотрудника по его uuid с настройками | https://{IP_контроллера}/api/v1/tmp_access/by_user/6f81b240-4471-11f1-9f8e-53d4d6bb592f |
Параметры запроса:
Наименование, * - обязательный | Описание |
user_uuid* string (path) | уникальный идентификатор сотрудника |
Варианты ответа:
Code 200 (Successfully got all temporary access) - удачное выполнение запроса
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ |
Пример:
[{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}]
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ сотрудника с указанным uuid не существуе
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Get specified temporary-access",
"parameters": [
{
"in": "path",
"name": "user_uuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully got all temporary access",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access was not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/tmp_access/by_user/{user_uuid}" \
-H "Authorization: Bearer <token>"
Пример ответа
[
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
]
GET /tmp_access/by_user_and_date/{user_uuid}/{date}
Раздел: Временный доступ.
Возвращает список всех разовых доступов для конкретного пользователя по его uuid и дате с настройками
Назначение | URL запроса |
Возвращает список всех разовых доступов для конкретного пользователя по его uuid и дате с настройками | https://{IP_контроллера}/api/v1/tmp_access/by_date/9d797661-a4db-4ea3-aba2-21d15a47d789/25.02.2022 |
Параметры запроса:
Наименование, * - обязательный | Описание |
user_uuid* string (path) | uuid сотрудника |
date* string (path) | дата доступа разового пропуска |
Варианты ответа:
Code 200 (Successfully got all temporary access) - удачное выполнение запроса
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ |
Пример:
[{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}]
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ сотрудника на указанную дату или с указанным uuid не существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Get specified temporary-access",
"parameters": [
{
"in": "path",
"name": "user_uuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "date",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully got all temporary access",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access was not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/tmp_access/by_user_and_date/{user_uuid}/{date}" \
-H "Authorization: Bearer <token>"
Пример ответа
[
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
]
GET /tmp_access/{uuid}
Раздел: Временный доступ.
Возвращает конкретный разовый доступ по uuid разового доступа с его настройками
Назначение | URL запроса |
Возвращает конкретный разовый доступ по uuid разового доступа с его настройками | https://{IP_контроллера}/api/v1/tmp_access/70879013-1d6e-4459-bf70-84aab555ac19 |
Параметры запроса:
Наименование, * - обязательный | Описание |
uuid* string (path) | уникальный идентификатор разового доступа |
Варианты ответа:
Code 200 (Got specified temporary-access) - удачное выполнение запроса
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ |
Пример:
{
"interval_from": "9:00",
"uuid": "a5a38841-536b-11f1-a867-9b9c73661e4e",
"user_uuid": "6f81b240-4471-11f1-9f8e-53d4d6bb592f",
"interval_to": "18:00",
"date": "19.05.2026",
"access_points": [
"3e4c9860-4de6-11f1-b374-057c15e55d12",
"41178c20-503f-11f1-9e4a-975446c45c79"
]
}
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ с указанным uuid не существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Get specified temporary-access",
"parameters": [
{
"in": "path",
"name": "uuid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Got specified temporary-access",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access was not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/tmp_access/{uuid}" \
-H "Authorization: Bearer <token>"
Пример ответа
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
PUT /tmp_access/{uuid}
Раздел: Временный доступ.
Редактирует уже существующие разовые доступы
Назначение | URL запроса |
Редактирует уже существующие разовые доступы | https://{IP_контроллера}/api/v1/tmp_access/5e55f6c1-6f20-44eb-893d-a8c22b61e251 |
Параметры запроса:
Название | Тип | Описание | |
uuid* | string (path) | uuid разового доступа | |
tmp_access* | object (body) | тело запроса | |
BODY | |||
Название, * - обязательный | Тип | Формат | Назначение |
uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор разового доступа |
user_uuid* | string | pattern:/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i | уникальный идентификатор сотрудника, которому предоставляется доступ |
interval_from* | string | minLength: 4, maxLength: 5 | Время начала действия доступа в формате: "ч:мин" - “9:30” |
interval_to* | string | minLength: 4, maxLength: 5 | Время окончания действия доступа в формате: "ч:мин" - “17:00” |
date* | string | minLength: 10, maxLength: 10 | Дата доступа в формате: "дд.мм.гггг" |
access_points* | [string] | список уникальных идентификаторовточек прохода на которые предоставляется доступ | |
Пример:
URL запроса: PUT
https://{IP_контроллера}/api/v1/tmp_access/5e55f6c1-6f20-44eb-893d-a8c22b61e251
Body
{
"uuid": "2899e091-98d2-11ec-b21e-b5be8bb5cbdd",
"user_uuid": "6ba5d8e0-5ce5-11ec-a195-fb1e5495dfa6",
"interval_from": "9:00",
"interval_to": "18:00",
"date": "01.03.2022",
"access_points": [
"a3951730-7477-11ec-aafa-0997381d51e8",
"d82079e0-7477-11ec-aafa-0997381d51e8",
"636f6740-79f0-11ec-adad-1363f78032b3"
]
}
Варианты ответа:
Code 200 (Access profile successfully modified) - удачное выполнение запроса
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ с указанным uuid не существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Modify temporary-access",
"parameters": [
{
"in": "path",
"name": "uuid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"uuid",
"user_uuid",
"interval_from",
"interval_to",
"date",
"access_points"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"user_uuid": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "User to give access to"
},
"interval_from": {
"type": "string",
"description": "Interval to give access from in format: \"h:mm\". For example: 9:00",
"minLength": 4,
"maxLength": 5
},
"interval_to": {
"type": "string",
"description": "Interval to give access to in format: \"h:mm\". For example: 17:00",
"minLength": 4,
"maxLength": 5
},
"date": {
"type": "string",
"description": "Access date in format: \"dd.MM.yyyy\"",
"minLength": 10,
"maxLength": 10
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Access profile successfully modified",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access does not exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X PUT "https://{IP_контроллера}/api/v1/tmp_access/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}'
Пример тела запроса
{
"uuid": "string",
"user_uuid": "string",
"interval_from": "strin",
"interval_to": "strin",
"date": "stringxxxx",
"access_points": [
"string"
]
}
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}
DELETE /tmp_access/{uuid}
Раздел: Временный доступ.
Удаляет существующий разовый доступ
Назначение | URL запроса |
Удаляет существующий разовый доступ | https://{IP_контроллера}/api/v1/tmp_access/5e55f6c1-6f20-44eb-893d-a8c22b61e251 |
Параметры запроса:
Наименование, * - обязательный | Описание |
uuid* string (path) | uuid разового доступа |
Варианты ответа:
Code 200 (Access profile successfully deleted) - удачное выполнение запроса
Code 400 (Invalid UUID) - запрос не выполнен, указан некорректный uuid
Code 404 (Specified temporary-access was not found) - запрос не выполнен, разовый доступ с указанным uuid не существует
Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке
Параметры и ответы по OpenAPI
{
"description": "Delete temporary-access",
"parameters": [
{
"in": "path",
"name": "uuid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Access profile successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Invalid UUID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Specified temporary-access does not exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Something went wrong. It seems there is a bug on server",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X DELETE "https://{IP_контроллера}/api/v1/tmp_access/{uuid}" \
-H "Authorization: Bearer <token>"
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}