Авторизация
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Гостевой токен сессии своего кабинета.
Параметры
limitПараметр запроса · НеобязательноНеобязательное максимальное число записей страницы. Метаданные пагинации ответа указывают, как получить оставшиеся результаты.
integerПолное определение
{ "minimum": 1, "maximum": 50, "default": 20, "type": "integer", "example": 20 }cursorПараметр запроса · НеобязательноНеобязательный непрозрачный курсор предыдущей страницы. Для продолжения передайте его без изменений с теми же областью доступа и фильтрами.
stringПолное определение
{ "maxLength": 2048, "type": "string", "example": "example" }
Ответы
200Возвращает страницу истории гостя и метаданные продолжения.
Полное определение
{
"$ref": "#/components/schemas/GuestPortalHistoryResultDto"
}{
"items": [
{
"id": "af924415-09ad-48f0-8889-e7ae8d3b1d06",
"type": "RESERVATION",
"status": "example",
"occurredAt": "2026-01-15T12:00:00.000Z",
"partySize": 0
}
],
"hasMore": true
}401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ guestPortalToken на границе владеющего домена.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}Схемы
GuestPortalHistoryResultDto
Возвращает страницу истории гостя и метаданные продолжения.
itemsОбязательноКоллекция
itemsв составе представления.arrayПолное определение
{ "type": "array", "items": { "type": "object", "required": [ "id", "type", "status", "occurredAt", "partySize" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID Hallify для `id`.", "example": "af924415-09ad-48f0-8889-e7ae8d3b1d06" }, "type": { "type": "string", "enum": [ "RESERVATION", "VISIT", "ORDER" ], "description": "Допустимые значения `type`: RESERVATION, VISIT, ORDER.", "example": "RESERVATION" }, "status": { "type": "string", "description": "Текущий статус жизненного цикла `status`.", "example": "example" }, "occurredAt": { "type": "string", "format": "date-time", "description": "Время `occurredAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-01-15T12:00:00.000Z" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Время `completedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.", "example": "2026-01-15T13:00:00.000Z" }, "partySize": { "type": "integer", "description": "Целочисленное значение `partySize`.", "example": 0 }, "reference": { "type": "string", "nullable": true, "description": "Ссылочный идентификатор `reference`, назначенный человеком или провайдером для сверки с исходной записью. Null означает отсутствие записанного значения в этом представлении.", "example": "example-reference" } }, "example": { "id": "af924415-09ad-48f0-8889-e7ae8d3b1d06", "type": "RESERVATION", "status": "example", "occurredAt": "2026-01-15T12:00:00.000Z", "partySize": 0 } }, "description": "Коллекция `items` в составе представления.", "example": [ { "id": "af924415-09ad-48f0-8889-e7ae8d3b1d06", "type": "RESERVATION", "status": "example", "occurredAt": "2026-01-15T12:00:00.000Z", "partySize": 0 } ] }nextCursorНеобязательноНепрозрачный курсор пагинации
nextCursor. Передайте его без изменений с теми же фильтрами. Null означает отсутствие записанного значения в этом представлении.string · nullПолное определение
{ "type": "string", "nullable": true, "description": "Непрозрачный курсор пагинации `nextCursor`. Передайте его без изменений с теми же фильтрами. Null означает отсутствие записанного значения в этом представлении.", "example": "example" }hasMoreОбязательноЕсть ли следующая страница истории гостевого кабинета.
booleanПолное определение
{ "type": "boolean", "description": "Есть ли следующая страница истории гостевого кабинета.", "example": true }
Полное определение
{
"type": "object",
"required": [
"items",
"hasMore"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"status",
"occurredAt",
"partySize"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `id`.",
"example": "af924415-09ad-48f0-8889-e7ae8d3b1d06"
},
"type": {
"type": "string",
"enum": [
"RESERVATION",
"VISIT",
"ORDER"
],
"description": "Допустимые значения `type`: RESERVATION, VISIT, ORDER.",
"example": "RESERVATION"
},
"status": {
"type": "string",
"description": "Текущий статус жизненного цикла `status`.",
"example": "example"
},
"occurredAt": {
"type": "string",
"format": "date-time",
"description": "Время `occurredAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-01-15T12:00:00.000Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Время `completedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
"example": "2026-01-15T13:00:00.000Z"
},
"partySize": {
"type": "integer",
"description": "Целочисленное значение `partySize`.",
"example": 0
},
"reference": {
"type": "string",
"nullable": true,
"description": "Ссылочный идентификатор `reference`, назначенный человеком или провайдером для сверки с исходной записью. Null означает отсутствие записанного значения в этом представлении.",
"example": "example-reference"
}
},
"example": {
"id": "af924415-09ad-48f0-8889-e7ae8d3b1d06",
"type": "RESERVATION",
"status": "example",
"occurredAt": "2026-01-15T12:00:00.000Z",
"partySize": 0
}
},
"description": "Коллекция `items` в составе представления.",
"example": [
{
"id": "af924415-09ad-48f0-8889-e7ae8d3b1d06",
"type": "RESERVATION",
"status": "example",
"occurredAt": "2026-01-15T12:00:00.000Z",
"partySize": 0
}
]
},
"nextCursor": {
"type": "string",
"nullable": true,
"description": "Непрозрачный курсор пагинации `nextCursor`. Передайте его без изменений с теми же фильтрами. Null означает отсутствие записанного значения в этом представлении.",
"example": "example"
},
"hasMore": {
"type": "boolean",
"description": "Есть ли следующая страница истории гостевого кабинета.",
"example": true
}
},
"description": "Возвращает страницу истории гостя и метаданные продолжения.",
"example": {
"items": [
{
"id": "af924415-09ad-48f0-8889-e7ae8d3b1d06",
"type": "RESERVATION",
"status": "example",
"occurredAt": "2026-01-15T12:00:00.000Z",
"partySize": 0
}
],
"hasMore": true
}
}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"
}