Перейти к содержимому
Разделы

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

Подтвердить гостевое бронирование

POST/public/reservations/manage/confirm

Подтверждает бронирование по токену управления и ожидаемой ревизии, если текущее состояние допускает подтверждение гостем. Обязательный Idempotency-Key возвращает сохранённые статус и тело при повторе того же запроса; повторное использование ключа с другим телом возвращает 409.

Авторизация

Authorization: Bearer <HALLIFY_RESERVATION_MANAGE_TOKEN>

Гостевой токен управления своим бронированием или записью листа ожидания.

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

Параметры

idempotency-keyЗаголовок · Обязательно

Обязательный ключ идемпотентности длиной до 128 символов.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 128,
  "example": "example"
}

Тело запроса

Обязательно

Подтверждает бронирование по токену управления и ожидаемой ревизии, если текущее состояние допускает подтверждение гостем.

application/json

PublicManageActionDto
Полное определение
{
  "$ref": "#/components/schemas/PublicManageActionDto"
}

Ответы

200Возвращает квитанцию подтверждённого бронирования и, когда применимо, заменённый токен управления.
ReservationCommandResultDto
Полное определение
{
  "$ref": "#/components/schemas/ReservationCommandResultDto"
}
Пример ответа · 200 · application/json
{
  "entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
  "referenceCode": "EXAMPLE",
  "revision": 1,
  "status": "example",
  "warningCodes": [
    "EXAMPLE"
  ],
  "eventIds": [
    "6825b43e-93d6-4f3b-8171-c1661099fae8"
  ]
}
401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ reservationManageToken на границе владеющего домена.
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"
}
409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
IdempotencyConflictError
Полное определение
{
  "$ref": "#/components/schemas/IdempotencyConflictError"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
  "message": "errors:idempotency.inProgress",
  "translationKey": "errors:idempotency.inProgress"
}

Схемы

PublicManageActionDto

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

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

Текущая целочисленная ревизия expectedRevision, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.",
  "example": 1
}
scheduledAtНеобязательно

Время scheduledAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-01-15T12:00:00.000Z"
}
servicePeriodIdНеобязательно

UUID Hallify для servicePeriodId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `servicePeriodId`.",
  "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
}
partySizeНеобязательно

Целочисленное значение partySize. Ограничения: минимум 1; максимум 99.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "maximum": 99,
  "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.",
  "example": 1
}
Полное определение
{
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 1,
      "description": "Текущая целочисленная ревизия `expectedRevision`, прочитанная вызывающей стороной; устаревшее значение приводит к отклонению изменения. Ограничения: минимум 1.",
      "example": 1
    },
    "scheduledAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "servicePeriodId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `servicePeriodId`.",
      "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 99,
      "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.",
      "example": 1
    }
  },
  "required": [
    "expectedRevision"
  ],
  "description": "Ревизия бронирования, разрешённого токеном, и необязательные изменения расписания, периода обслуживания и количества гостей для гостевых команд подтверждения, изменения и отмены.",
  "example": {
    "expectedRevision": 1
  }
}
ReservationCommandResultDto

Возвращает квитанцию команды бронирования или листа ожидания, ревизию, жизненный цикл и итоговое состояние доступности.

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

UUID Hallify для entityId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `entityId`.",
  "example": "6b288694-8b6d-49cd-8007-264ca7224921"
}
referenceCodeОбязательно

Стабильный код referenceCode для классификации или идентификации.

string
Полное определение
{
  "type": "string",
  "description": "Стабильный код `referenceCode` для классификации или идентификации.",
  "example": "EXAMPLE"
}
revisionОбязательно

Монотонно возрастающая ревизия revision для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.",
  "example": 1
}
statusОбязательно

Текущий статус жизненного цикла status.

string
Полное определение
{
  "type": "string",
  "description": "Текущий статус жизненного цикла `status`.",
  "example": "example"
}
warningCodesОбязательно

Значения warningCodes, переданные для проверки или исправления вызывающей стороной.

array
Полное определение
{
  "type": "array",
  "items": {
    "type": "string",
    "example": "EXAMPLE"
  },
  "description": "Значения `warningCodes`, переданные для проверки или исправления вызывающей стороной.",
  "example": [
    "EXAMPLE"
  ]
}
eventIdsОбязательно

Набор идентификаторов UUID Hallify в eventIds.

array
Полное определение
{
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "example": "6825b43e-93d6-4f3b-8171-c1661099fae8"
  },
  "description": "Набор идентификаторов UUID Hallify в `eventIds`.",
  "example": [
    "6825b43e-93d6-4f3b-8171-c1661099fae8"
  ]
}
Полное определение
{
  "type": "object",
  "required": [
    "entityId",
    "referenceCode",
    "revision",
    "status",
    "warningCodes",
    "eventIds"
  ],
  "properties": {
    "entityId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `entityId`.",
      "example": "6b288694-8b6d-49cd-8007-264ca7224921"
    },
    "referenceCode": {
      "type": "string",
      "description": "Стабильный код `referenceCode` для классификации или идентификации.",
      "example": "EXAMPLE"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений. Ограничения: минимум 1.",
      "example": 1
    },
    "status": {
      "type": "string",
      "description": "Текущий статус жизненного цикла `status`.",
      "example": "example"
    },
    "warningCodes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "EXAMPLE"
      },
      "description": "Значения `warningCodes`, переданные для проверки или исправления вызывающей стороной.",
      "example": [
        "EXAMPLE"
      ]
    },
    "eventIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "6825b43e-93d6-4f3b-8171-c1661099fae8"
      },
      "description": "Набор идентификаторов UUID Hallify в `eventIds`.",
      "example": [
        "6825b43e-93d6-4f3b-8171-c1661099fae8"
      ]
    }
  },
  "description": "Возвращает квитанцию команды бронирования или листа ожидания, ревизию, жизненный цикл и итоговое состояние доступности.",
  "example": {
    "entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
    "referenceCode": "EXAMPLE",
    "revision": 1,
    "status": "example",
    "warningCodes": [
      "EXAMPLE"
    ],
    "eventIds": [
      "6825b43e-93d6-4f3b-8171-c1661099fae8"
    ]
  }
}
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"
}
IdempotencyConflictError

Ключ идемпотентности уже обрабатывается или использован повторно с другим телом.

Полное определение
{
  "example": {
    "statusCode": 409,
    "error": "errors:http.conflict",
    "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
    "message": "errors:idempotency.inProgress",
    "translationKey": "errors:idempotency.inProgress"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/TranslatedErrorDto"
    },
    {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "statusCode": {
          "type": "integer",
          "enum": [
            409
          ],
          "description": "Статус конфликта HTTP 409.",
          "example": 409
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_REQUEST_NOT_READY",
            "IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
            "IDEMPOTENCY_REQUEST_IN_PROGRESS",
            "IDEMPOTENCY_SCOPE_INCOMPLETE"
          ],
          "description": "Допустимые значения `code`: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
          "example": "IDEMPOTENCY_REQUEST_NOT_READY"
        }
      },
      "example": {
        "code": "IDEMPOTENCY_REQUEST_NOT_READY"
      }
    }
  ],
  "description": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}

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

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