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

Бронирования и лист ожидания

Прочитать состояние проверки своего публичного намерения

GET/public/reservations/{publicHandle}/intents/{intentId}

Читает только обезличенное состояние намерения и проверки для точного нативного канала и исходного request fingerprint при текущих правах Origin/presentation. Один ID намерения не даёт прав. Метод не возвращает контакт, код, детали брони или manage-capability, не создаёт бронь и не продлевает сроки.

Авторизация

x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>

Краткосрочный server-authenticated widget presentation proof. Связывает настроенный frame origin с точными проверенными parent binding и connection authority. Новый widget-спрос требует этот proof; существующие native capabilities сохраняют отдельные права и исходные сроки.

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

Параметры

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

Опубликованный нативный канал бронирования, которому принадлежит намерение.

string
Полное определение
{
  "type": "string",
  "example": "example"
}
intentIdПуть · Обязательно

UUID исходного намерения проверки, связанный с request fingerprint и текущими Origin/presentation; сам ID не даёт прав управления или оплаты.

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

Фактический Origin браузерного запроса для проверки текущих прав представления. Обязателен для новых заявок и продолжения через Storefront. Канонические браузерные запросы Hallify используют Origin, настроенный в HALLIFY_PUBLIC_APP_URL. Заголовок передаёт контекст запроса, не авторизует вызывающего и не заменяет соответствующий гостевой ключ.

string · uri
Полное определение
{
  "type": "string",
  "format": "uri",
  "maxLength": 2048,
  "example": "https://example.test/resource"
}
x-hallify-connection-idЗаголовок · Необязательно

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

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

Ответы

200Возвращает текущее ожидающее, использованное или истёкшее состояние намерения и безопасные сведения о сроке проверки, доставке и повторной отправке.
ReservationPublicPendingIntentDto
Полное определение
{
  "$ref": "#/components/schemas/ReservationPublicPendingIntentDto"
}
Пример ответа · 200 · application/json
{
  "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
  "kind": "BOOKING",
  "status": "PENDING_VERIFICATION",
  "expiresAt": "2026-12-31T18:00:00.000Z",
  "expired": true,
  "canVerify": true,
  "verification": {
    "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "status": "PENDING",
    "deliveryStatus": "QUEUED",
    "attemptsRemaining": 0,
    "canResend": true,
    "resendAvailableAt": null
  },
  "serverTime": "2026-12-31T18:00:00.000Z"
}
404Точные канал, намерение, request fingerprint или текущее представление недоступны; принадлежность намерения и контактные данные не раскрываются.
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"
}

Схемы

ReservationPublicPendingIntentDto

Текущее состояние намерения и проверки контакта для точного своего канала и исходного request fingerprint при текущих правах Origin/presentation. Не содержит контакт, код, сведения владельца или manage-capability.

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

Точный ID ожидающего или исторического намерения; само значение не даёт прав чтения или управления.

string · uuid
Полное определение
{
  "type": "string",
  "description": "Точный ID ожидающего или исторического намерения; само значение не даёт прав чтения или управления.",
  "format": "uuid",
  "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
}
kindОбязательно

Запрашивает ли намерение бронь или удалённую запись ожидания.

string
Полное определение
{
  "type": "string",
  "description": "Запрашивает ли намерение бронь или удалённую запись ожидания.",
  "enum": [
    "BOOKING",
    "WAITLIST"
  ],
  "example": "BOOKING"
}
statusОбязательно

Сохранённый нативный статус намерения. Срок также оценивается по serverTime без изменения сохранённого жизненного цикла при чтении.

string
Полное определение
{
  "type": "string",
  "description": "Сохранённый нативный статус намерения. Срок также оценивается по serverTime без изменения сохранённого жизненного цикла при чтении.",
  "enum": [
    "PENDING_VERIFICATION",
    "VERIFIED",
    "CONSUMED",
    "CANCELED",
    "EXPIRED"
  ],
  "example": "PENDING_VERIFICATION"
}
expiresAtОбязательно

Исходный срок намерения или удержания вместимости; чтение не продлевает его.

string · date-time
Полное определение
{
  "type": "string",
  "description": "Исходный срок намерения или удержания вместимости; чтение не продлевает его.",
  "format": "date-time",
  "example": "2026-12-31T18:00:00.000Z"
}
expiredОбязательно

Истёк ли исходный срок намерения на serverTime.

boolean
Полное определение
{
  "type": "boolean",
  "description": "Истёк ли исходный срок намерения на serverTime.",
  "example": true
}
canVerifyОбязательно

Разрешают ли текущее неиспользованное намерение и нативная проверка контакта подтверждение. Нативная конвертация перепроверяет вместимость, текущее представление и коммерческий допуск.

boolean
Полное определение
{
  "type": "boolean",
  "description": "Разрешают ли текущее неиспользованное намерение и нативная проверка контакта подтверждение. Нативная конвертация перепроверяет вместимость, текущее представление и коммерческий допуск.",
  "example": true
}
verificationОбязательно

Текущее обезличенное нативное состояние проверки контакта. Принятие доставки отделено от проверки кода; состояние не даёт прав управления бронью.

object
Полное определение
{
  "type": "object",
  "description": "Текущее обезличенное нативное состояние проверки контакта. Принятие доставки отделено от проверки кода; состояние не даёт прав управления бронью.",
  "additionalProperties": false,
  "required": [
    "verificationId",
    "expiresAt",
    "status",
    "deliveryStatus",
    "attemptsRemaining",
    "canResend",
    "resendAvailableAt"
  ],
  "properties": {
    "verificationId": {
      "type": "string",
      "description": "ID проверки контакта этого точного намерения.",
      "format": "uuid",
      "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
    },
    "expiresAt": {
      "type": "string",
      "description": "Нативный срок контактного кода, независимый от срока удержания вместимости или намерения ожидания.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "status": {
      "type": "string",
      "description": "Нативный цикл проверки: ожидание кода, проверенная личность, использованное доказательство либо истёкшая или заблокированная проверка. Использованное доказательство не раскрывает и не продлевает manage-capability.",
      "enum": [
        "PENDING",
        "VERIFIED",
        "CONSUMED",
        "EXPIRED",
        "LOCKED"
      ],
      "example": "PENDING"
    },
    "deliveryStatus": {
      "type": "string",
      "description": "Нативное состояние доставки проверки. Очередь, отправка и Core-pending не завершены; sent/delivered не подтверждают код. Сбой, unknown или Core-unknown не означают успешную доставку и не разрешают заменяющую отправку.",
      "enum": [
        "QUEUED",
        "SENDING",
        "CORE_PENDING",
        "CORE_UNKNOWN",
        "CORE_FAILED",
        "SENT",
        "DELIVERED",
        "FAILED",
        "RECEIVED"
      ],
      "example": "QUEUED"
    },
    "attemptsRemaining": {
      "type": "integer",
      "description": "Оставшиеся нативные попытки ввода ожидаемого контактного кода.",
      "minimum": 0,
      "example": 0
    },
    "canResend": {
      "type": "boolean",
      "description": "Разрешают ли текущая нативная политика проверки и неистёкшее намерение запросить повторную отправку сейчас. Выполнение перепроверяет политику.",
      "example": true
    },
    "resendAvailableAt": {
      "type": "string",
      "description": "Нативная граница cooldown до срока намерения либо null, если следующего окна отправки сейчас нет. Одна отметка времени не даёт права на повтор.",
      "format": "date-time",
      "nullable": true,
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "status": "PENDING",
    "deliveryStatus": "QUEUED",
    "attemptsRemaining": 0,
    "canResend": true,
    "resendAvailableAt": null
  }
}
serverTimeОбязательно

Серверный момент для текущей проекции срока и повторов.

string · date-time
Полное определение
{
  "type": "string",
  "description": "Серверный момент для текущей проекции срока и повторов.",
  "format": "date-time",
  "example": "2026-12-31T18:00:00.000Z"
}
Полное определение
{
  "type": "object",
  "description": "Текущее состояние намерения и проверки контакта для точного своего канала и исходного request fingerprint при текущих правах Origin/presentation. Не содержит контакт, код, сведения владельца или manage-capability.",
  "additionalProperties": false,
  "required": [
    "intentId",
    "kind",
    "status",
    "expiresAt",
    "expired",
    "canVerify",
    "verification",
    "serverTime"
  ],
  "properties": {
    "intentId": {
      "type": "string",
      "description": "Точный ID ожидающего или исторического намерения; само значение не даёт прав чтения или управления.",
      "format": "uuid",
      "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
    },
    "kind": {
      "type": "string",
      "description": "Запрашивает ли намерение бронь или удалённую запись ожидания.",
      "enum": [
        "BOOKING",
        "WAITLIST"
      ],
      "example": "BOOKING"
    },
    "status": {
      "type": "string",
      "description": "Сохранённый нативный статус намерения. Срок также оценивается по serverTime без изменения сохранённого жизненного цикла при чтении.",
      "enum": [
        "PENDING_VERIFICATION",
        "VERIFIED",
        "CONSUMED",
        "CANCELED",
        "EXPIRED"
      ],
      "example": "PENDING_VERIFICATION"
    },
    "expiresAt": {
      "type": "string",
      "description": "Исходный срок намерения или удержания вместимости; чтение не продлевает его.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "expired": {
      "type": "boolean",
      "description": "Истёк ли исходный срок намерения на serverTime.",
      "example": true
    },
    "canVerify": {
      "type": "boolean",
      "description": "Разрешают ли текущее неиспользованное намерение и нативная проверка контакта подтверждение. Нативная конвертация перепроверяет вместимость, текущее представление и коммерческий допуск.",
      "example": true
    },
    "verification": {
      "type": "object",
      "description": "Текущее обезличенное нативное состояние проверки контакта. Принятие доставки отделено от проверки кода; состояние не даёт прав управления бронью.",
      "additionalProperties": false,
      "required": [
        "verificationId",
        "expiresAt",
        "status",
        "deliveryStatus",
        "attemptsRemaining",
        "canResend",
        "resendAvailableAt"
      ],
      "properties": {
        "verificationId": {
          "type": "string",
          "description": "ID проверки контакта этого точного намерения.",
          "format": "uuid",
          "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
        },
        "expiresAt": {
          "type": "string",
          "description": "Нативный срок контактного кода, независимый от срока удержания вместимости или намерения ожидания.",
          "format": "date-time",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "status": {
          "type": "string",
          "description": "Нативный цикл проверки: ожидание кода, проверенная личность, использованное доказательство либо истёкшая или заблокированная проверка. Использованное доказательство не раскрывает и не продлевает manage-capability.",
          "enum": [
            "PENDING",
            "VERIFIED",
            "CONSUMED",
            "EXPIRED",
            "LOCKED"
          ],
          "example": "PENDING"
        },
        "deliveryStatus": {
          "type": "string",
          "description": "Нативное состояние доставки проверки. Очередь, отправка и Core-pending не завершены; sent/delivered не подтверждают код. Сбой, unknown или Core-unknown не означают успешную доставку и не разрешают заменяющую отправку.",
          "enum": [
            "QUEUED",
            "SENDING",
            "CORE_PENDING",
            "CORE_UNKNOWN",
            "CORE_FAILED",
            "SENT",
            "DELIVERED",
            "FAILED",
            "RECEIVED"
          ],
          "example": "QUEUED"
        },
        "attemptsRemaining": {
          "type": "integer",
          "description": "Оставшиеся нативные попытки ввода ожидаемого контактного кода.",
          "minimum": 0,
          "example": 0
        },
        "canResend": {
          "type": "boolean",
          "description": "Разрешают ли текущая нативная политика проверки и неистёкшее намерение запросить повторную отправку сейчас. Выполнение перепроверяет политику.",
          "example": true
        },
        "resendAvailableAt": {
          "type": "string",
          "description": "Нативная граница cooldown до срока намерения либо null, если следующего окна отправки сейчас нет. Одна отметка времени не даёт права на повтор.",
          "format": "date-time",
          "nullable": true,
          "example": "2026-12-31T18:00:00.000Z"
        }
      },
      "example": {
        "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
        "expiresAt": "2026-12-31T18:00:00.000Z",
        "status": "PENDING",
        "deliveryStatus": "QUEUED",
        "attemptsRemaining": 0,
        "canResend": true,
        "resendAvailableAt": null
      }
    },
    "serverTime": {
      "type": "string",
      "description": "Серверный момент для текущей проекции срока и повторов.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
    "kind": "BOOKING",
    "status": "PENDING_VERIFICATION",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "expired": true,
    "canVerify": true,
    "verification": {
      "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
      "expiresAt": "2026-12-31T18:00:00.000Z",
      "status": "PENDING",
      "deliveryStatus": "QUEUED",
      "attemptsRemaining": 0,
      "canResend": true,
      "resendAvailableAt": null
    },
    "serverTime": "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 поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.