Перейти к содержимому
HallifyРазработчикамПоиск по документации
Открыть Hallify
Разделы

Гостевой кабинет

Получить собственные исходные квитанции QR-заказов

GET/guest-portal/qr-visits/{associationId}/order-requests

Фильтрует по точным исходным TablePublicOrderRequest.membershipId, session и seat до ограниченного запроса. Читает только зафиксированные документы; не следует за перенесёнными Orders и не завершает срок нативного спроса при чтении.

Авторизация

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

Гостевой токен сессии своего кабинета.

Руководство по подключению

Параметры

associationIdПуть · Обязательно

Неизменная исходная QR association, принадлежащая аутентифицированному субъекту Portal.

string · uuid
Полное определение
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}
limitПараметр запроса · Необязательно

Максимальное число квитанций заказов собственной membership на этой странице.

integer
Полное определение
{
  "minimum": 1,
  "maximum": 50,
  "default": 20,
  "type": "integer",
  "example": 20
}
cursorПараметр запроса · Необязательно

UUID последнего запроса предыдущей страницы в этой точной области исходной membership.

string · uuid
Полное определение
{
  "format": "uuid",
  "type": "string",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Ответы

200Ограниченная страница собственных запросов с явными признаками недоступности старых подтверждающих данных.
GuestPortalQrOwnOrderRequestsPageDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPortalQrOwnOrderRequestsPageDto"
}
Пример ответа · 200 · application/json
{
  "items": [
    {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}
400Некорректные входные данные, изменённый текст согласия или недействительный целевой proof/OTP. Попытки с неверным OTP фиксируются.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401Исходный QR bearer/фактический Origin или текущая сессия Portal недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403Приватная история требует текущего подтверждения контакта. Отзыв согласия не требует свежего OTP.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404Точная принадлежащая гостю association или допустимый исходный запрос недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
429Канонический бюджет попыток проверки контакта исчерпан.

Заголовки ответа

Retry-After

Целое количество секунд ожидания перед повтором отклонённого запроса.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "example": 60
}
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 429 · application/json
{
  "statusCode": 429,
  "error": "errors:http.tooManyRequests",
  "code": "HTTP_TOO_MANY_REQUESTS",
  "message": "errors:http.tooManyRequests",
  "translationKey": "errors:http.tooManyRequests"
}
503Политика защищённых данных или ключи шифрования команд недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Схемы

GuestPortalQrOwnOrderRequestsPageDto

Ограниченная история запросов исходной QR membership с сохранением признаков недоступности старых подтверждающих данных.

itemsОбязательно

Только запросы исходной связанной membership, session и seat.

array
Полное определение
{
  "type": "array",
  "maxItems": 50,
  "description": "Только запросы исходной связанной membership, session и seat.",
  "items": {
    "oneOf": [
      {
        "type": "object",
        "description": "Исходный запрос в данной области, сохранённые зафиксированные подтверждающие данные которого нельзя безопасно прочитать.",
        "additionalProperties": false,
        "required": [
          "availability",
          "id",
          "createdAt"
        ],
        "properties": {
          "availability": {
            "type": "string",
            "enum": [
              "LEGACY_UNAVAILABLE"
            ],
            "description": "Исходные зафиксированные подтверждающие данные недоступны или повреждены; владение и сумма счёта не выводятся косвенно.",
            "example": "LEGACY_UNAVAILABLE"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID исходного запроса заказа в данной области.",
            "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Исходное время запроса в данной области.",
            "example": "2026-01-15T10:00:00.000Z"
          }
        },
        "example": {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      },
      {
        "allOf": [
          {
            "$ref": "#/components/schemas/TablePublicOrderCommandDto"
          },
          {
            "type": "object",
            "description": "Признак доступности исходного зафиксированного запроса с проверенной целостностью.",
            "required": [
              "availability"
            ],
            "properties": {
              "availability": {
                "type": "string",
                "enum": [
                  "AVAILABLE"
                ],
                "description": "Канонические подтверждающие данные зафиксированного запроса доступны для чтения и прошли проверку целостности.",
                "example": "AVAILABLE"
              }
            },
            "example": {
              "availability": "AVAILABLE"
            }
          }
        ],
        "example": {
          "id": "fada03e2-505e-4bb9-80a9-716350866411",
          "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
          "revision": 1,
          "mode": "DIRECT",
          "status": "PENDING",
          "orderId": null,
          "decisionReason": null,
          "decidedAt": null,
          "createdAt": "2026-01-15T10:00:00.000Z",
          "expiresAt": "2026-12-31T18:00:00.000Z",
          "availability": "AVAILABLE"
        }
      }
    ],
    "example": {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  },
  "example": [
    {
      "availability": "LEGACY_UNAVAILABLE",
      "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ]
}
nextCursorОбязательно

UUID последнего запроса в данной области для следующей страницы; null в конце.

string · uuid · null
Полное определение
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "UUID последнего запроса в данной области для следующей страницы; null в конце.",
  "example": "2117e111-06c9-477b-8d9a-3fb4313e8d93"
}
Полное определение
{
  "type": "object",
  "description": "Ограниченная история запросов исходной QR membership с сохранением признаков недоступности старых подтверждающих данных.",
  "additionalProperties": false,
  "required": [
    "items",
    "nextCursor"
  ],
  "properties": {
    "items": {
      "type": "array",
      "maxItems": 50,
      "description": "Только запросы исходной связанной membership, session и seat.",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "description": "Исходный запрос в данной области, сохранённые зафиксированные подтверждающие данные которого нельзя безопасно прочитать.",
            "additionalProperties": false,
            "required": [
              "availability",
              "id",
              "createdAt"
            ],
            "properties": {
              "availability": {
                "type": "string",
                "enum": [
                  "LEGACY_UNAVAILABLE"
                ],
                "description": "Исходные зафиксированные подтверждающие данные недоступны или повреждены; владение и сумма счёта не выводятся косвенно.",
                "example": "LEGACY_UNAVAILABLE"
              },
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "UUID исходного запроса заказа в данной области.",
                "example": "a42073ae-5313-4ace-86d8-86fb33fde1a9"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "description": "Исходное время запроса в данной области.",
                "example": "2026-01-15T10:00:00.000Z"
              }
            },
            "example": {
              "availability": "LEGACY_UNAVAILABLE",
              "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
              "createdAt": "2026-01-15T10:00:00.000Z"
            }
          },
          {
            "allOf": [
              {
                "$ref": "#/components/schemas/TablePublicOrderCommandDto"
              },
              {
                "type": "object",
                "description": "Признак доступности исходного зафиксированного запроса с проверенной целостностью.",
                "required": [
                  "availability"
                ],
                "properties": {
                  "availability": {
                    "type": "string",
                    "enum": [
                      "AVAILABLE"
                    ],
                    "description": "Канонические подтверждающие данные зафиксированного запроса доступны для чтения и прошли проверку целостности.",
                    "example": "AVAILABLE"
                  }
                },
                "example": {
                  "availability": "AVAILABLE"
                }
              }
            ],
            "example": {
              "id": "fada03e2-505e-4bb9-80a9-716350866411",
              "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
              "revision": 1,
              "mode": "DIRECT",
              "status": "PENDING",
              "orderId": null,
              "decisionReason": null,
              "decidedAt": null,
              "createdAt": "2026-01-15T10:00:00.000Z",
              "expiresAt": "2026-12-31T18:00:00.000Z",
              "availability": "AVAILABLE"
            }
          }
        ],
        "example": {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      },
      "example": [
        {
          "availability": "LEGACY_UNAVAILABLE",
          "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
          "createdAt": "2026-01-15T10:00:00.000Z"
        }
      ]
    },
    "nextCursor": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "UUID последнего запроса в данной области для следующей страницы; null в конце.",
      "example": "2117e111-06c9-477b-8d9a-3fb4313e8d93"
    }
  },
  "example": {
    "items": [
      {
        "availability": "LEGACY_UNAVAILABLE",
        "id": "a42073ae-5313-4ace-86d8-86fb33fde1a9",
        "createdAt": "2026-01-15T10:00:00.000Z"
      }
    ],
    "nextCursor": null
  }
}
TablePublicOrderCommandDto

Краткая неизменяемая исходная квитанция команды заказа либо текущая безопасная сводка запроса; не содержит токена участия.

idОбязательно

Неизменяемый идентификатор гостевого запроса заказа, используемый также для корреляции нативного допуска.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Неизменяемый идентификатор гостевого запроса заказа, используемый также для корреляции нативного допуска.",
  "example": "fada03e2-505e-4bb9-80a9-716350866411"
}
tableSessionIdОбязательно

Исходная нативная сессия обслуживания стола, которой принадлежат запрос и допущенный набор.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Исходная нативная сессия обслуживания стола, которой принадлежат запрос и допущенный набор.",
  "example": "9b456a94-f735-466f-84ba-67aa863b2905"
}
revisionОбязательно

Текущая ревизия запроса. Решение сотрудника требует точной ревизии PENDING и увеличивает её один раз.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Текущая ревизия запроса. Решение сотрудника требует точной ревизии PENDING и увеличивает её один раз.",
  "example": 1
}
modeОбязательно

Режим допуска, неизменяемо зафиксированный при отправке запроса.

string
Полное определение
{
  "type": "string",
  "enum": [
    "DIRECT",
    "STAFF_CONFIRM"
  ],
  "description": "Режим допуска, неизменяемо зафиксированный при отправке запроса.",
  "example": "DIRECT"
}
statusОбязательно

Сохранённое состояние запроса. У PENDING нет нативного Order; окончательные состояния больше не меняются.

string
Полное определение
{
  "type": "string",
  "enum": [
    "PENDING",
    "ACCEPTED",
    "REJECTED",
    "INVALIDATED"
  ],
  "description": "Сохранённое состояние запроса. У PENDING нет нативного Order; окончательные состояния больше не меняются.",
  "example": "PENDING"
}
orderIdОбязательно

Канонический нативный Order набора, созданный допуском ACCEPTED, либо null до допуска и для отклонённых или недействительных запросов.

string · uuid · null
Полное определение
{
  "type": "string",
  "format": "uuid",
  "nullable": true,
  "description": "Канонический нативный Order набора, созданный допуском ACCEPTED, либо null до допуска и для отклонённых или недействительных запросов.",
  "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
}
decisionReasonОбязательно

Стабильная причина отклонения или утраты действия; null для PENDING и ACCEPTED. Не содержит заметок сотрудника или токена.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "maxLength": 64,
  "description": "Стабильная причина отклонения или утраты действия; null для PENDING и ACCEPTED. Не содержит заметок сотрудника или токена.",
  "example": "synthetic-example-credential"
}
decidedAtОбязательно

Сохранённое время окончательного решения либо null для PENDING.

string · date-time · null
Полное определение
{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "description": "Сохранённое время окончательного решения либо null для PENDING.",
  "example": "2026-01-15T12:00:00.000Z"
}
createdAtОбязательно

Неизменяемое серверное время создания, используемое вместе с UUID запроса для порядка курсора.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Неизменяемое серверное время создания, используемое вместе с UUID запроса для порядка курсора.",
  "example": "2026-01-15T10:00:00.000Z"
}
expiresAtОбязательно

Исходный фактический срок источника и расчёта. Просроченный ожидающий запрос не может быть допущен.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Исходный фактический срок источника и расчёта. Просроченный ожидающий запрос не может быть допущен.",
  "example": "2026-12-31T18:00:00.000Z"
}
Полное определение
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Неизменяемый идентификатор гостевого запроса заказа, используемый также для корреляции нативного допуска.",
      "example": "fada03e2-505e-4bb9-80a9-716350866411"
    },
    "tableSessionId": {
      "type": "string",
      "format": "uuid",
      "description": "Исходная нативная сессия обслуживания стола, которой принадлежат запрос и допущенный набор.",
      "example": "9b456a94-f735-466f-84ba-67aa863b2905"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Текущая ревизия запроса. Решение сотрудника требует точной ревизии PENDING и увеличивает её один раз.",
      "example": 1
    },
    "mode": {
      "type": "string",
      "enum": [
        "DIRECT",
        "STAFF_CONFIRM"
      ],
      "description": "Режим допуска, неизменяемо зафиксированный при отправке запроса.",
      "example": "DIRECT"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "REJECTED",
        "INVALIDATED"
      ],
      "description": "Сохранённое состояние запроса. У PENDING нет нативного Order; окончательные состояния больше не меняются.",
      "example": "PENDING"
    },
    "orderId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "Канонический нативный Order набора, созданный допуском ACCEPTED, либо null до допуска и для отклонённых или недействительных запросов.",
      "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
    },
    "decisionReason": {
      "type": "string",
      "nullable": true,
      "maxLength": 64,
      "description": "Стабильная причина отклонения или утраты действия; null для PENDING и ACCEPTED. Не содержит заметок сотрудника или токена.",
      "example": "synthetic-example-credential"
    },
    "decidedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Сохранённое время окончательного решения либо null для PENDING.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Неизменяемое серверное время создания, используемое вместе с UUID запроса для порядка курсора.",
      "example": "2026-01-15T10:00:00.000Z"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Исходный фактический срок источника и расчёта. Просроченный ожидающий запрос не может быть допущен.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "description": "Краткая неизменяемая исходная квитанция команды заказа либо текущая безопасная сводка запроса; не содержит токена участия.",
  "required": [
    "id",
    "tableSessionId",
    "revision",
    "mode",
    "status",
    "orderId",
    "decisionReason",
    "decidedAt",
    "createdAt",
    "expiresAt"
  ],
  "example": {
    "id": "fada03e2-505e-4bb9-80a9-716350866411",
    "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
    "revision": 1,
    "mode": "DIRECT",
    "status": "PENDING",
    "orderId": null,
    "decisionReason": null,
    "decidedAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}
TranslatedErrorDto

Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.

statusCodeОбязательно

HTTP-статус, повторённый из ответа.

integer
Полное определение
{
  "type": "integer",
  "description": "HTTP-статус, повторённый из ответа.",
  "example": 400
}
errorОбязательно

Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.

string
Полное определение
{
  "type": "string",
  "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
  "example": "errors.request.invalid"
}
codeОбязательно

Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.

string
Полное определение
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
}
messageОбязательно

Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
}
translationKeyОбязательно

Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsНеобязательно

Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.

array
Полное определение
{
  "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsНеобязательно

Необязательные сведения о доменных препятствиях или ошибках валидации.

oneOf
Полное определение
{
  "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP-статус, повторённый из ответа.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.

fieldОбязательно

Публичный путь поля. Вложенные свойства и индексы массива разделены точками.

string
Полное определение
{
  "type": "string",
  "example": "email",
  "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
}
translationKeyОбязательно

Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
}
codeОбязательно

Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.

string
Полное определение
{
  "type": "string",
  "example": "isEmail",
  "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
}
messageОбязательно

Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
Полное определение
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.

Полное определение
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
  "example": "example"
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.