Получить текущее участие в сессии стола Hallify

Авторизация

Authorization: Bearer <HALLIFY_TABLE_GUEST_TOKEN>

Гостевой ключ участия в сессии стола, ограниченный заведением, сессией, гостем, текущими эпохами доступа, ресурсом представления и Origin браузера.

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

Параметры

sessionIdПуть · Обязательно: Основная сессия обслуживания стола Hallify, которой принадлежат публичный доступ, запросы допуска и участие гостей, адресуемые этой операцией.
string · uuid
Полное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
originЗаголовок · Обязательно: Фактический Origin запроса, которым управляет браузер: используется для проверки разрешённого источника представления и его текущей привязки ресурса. Браузерные клиенты сохраняют это значение; авторизацию гостя предоставляет отдельный ключ запроса присоединения или участия в сессии.
string · uri
Полное определение
{ "type": "string", "format": "uri", "example": "https://example.test/resource" }

Ответы

200Безопасное текущее представление участия в сессии без ключей, контакта CRM и данных сотрудников.

TablePublicMembershipDto

Полное определение

{
  "$ref": "#/components/schemas/TablePublicMembershipDto"
}

Пример ответа · 200 · application/json

{
  "membershipId": "4db41e65-a63b-4932-883c-e6c4306ce684",
  "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
  "tableSessionGuestId": "cbca9476-6eef-441b-874e-918d61f54560",
  "guestLabel": "1.000",
  "tableLabel": "example",
  "paymentScope": "DISABLED",
  "revision": 1,
  "accessEpoch": 1,
  "policyAccessEpoch": 1,
  "expiresAt": "2026-12-31T18:00:00.000Z"
}

400Некорректный формат переданного идентификатора, запроса или ключа доступа.

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"
}

401QR-ключ, текущие права Hallify или точный Origin запроса не разрешены.

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"
}

404Текущий публичный идентификатор, привязка представления или принадлежащий ему ресурс Hallify недоступны.

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"
}

503Невозможно безопасно использовать QR-ключи или достоверное состояние Hallify.

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"
}

Схемы

TablePublicMembershipDto

Безопасное текущее представление участия вызывающего гостя в Hallify: операционный слот, подписи стола, эпохи доступа и исходный срок предоставленного участия.

membershipIdОбязательно: Текущее предоставленное участие в сессии.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "Текущее предоставленное участие в сессии.", "example": "4db41e65-a63b-4932-883c-e6c4306ce684" }
tableSessionIdОбязательно: Основная сессия обслуживания, принадлежащая гостю.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "Основная сессия обслуживания, принадлежащая гостю.", "example": "9b456a94-f735-466f-84ba-67aa863b2905" }
tableSessionGuestIdОбязательно: Операционный слот гостя, принадлежащий вызывающему.
string · uuid
Полное определение
{ "type": "string", "format": "uuid", "description": "Операционный слот гостя, принадлежащий вызывающему.", "example": "cbca9476-6eef-441b-874e-918d61f54560" }
guestLabelОбязательно: Отображаемая подпись операционного слота вызывающего гостя.
string
Полное определение
{ "type": "string", "description": "Отображаемая подпись операционного слота вызывающего гостя.", "example": "1.000" }
tableLabelОбязательно: Отображаемое обозначение текущего обслуживаемого стола.
string
Полное определение
{ "type": "string", "description": "Отображаемое обозначение текущего обслуживаемого стола.", "example": "example" }
paymentScopeОбязательно: Текущая подсказка политики заведения о доступности платёжного входа. Финансовые действия требуют текущих полномочий нативного платёжного источника и отдельного явного согласия.
string
Полное определение
{ "type": "string", "enum": [ "DISABLED", "ASSIGNED_ITEMS", "SESSION_BILL" ], "description": "Текущая подсказка политики заведения о доступности платёжного входа. Финансовые действия требуют текущих полномочий нативного платёжного источника и отдельного явного согласия.", "example": "DISABLED" }
revisionОбязательно: Текущая ревизия участия в сессии.
integer
Полное определение
{ "type": "integer", "minimum": 1, "description": "Текущая ревизия участия в сессии.", "example": 1 }
accessEpochОбязательно: Текущая эпоха доступа сессии.
integer
Полное определение
{ "type": "integer", "minimum": 1, "description": "Текущая эпоха доступа сессии.", "example": 1 }
policyAccessEpochОбязательно: Текущая эпоха доступа заведения.
integer
Полное определение
{ "type": "integer", "minimum": 1, "description": "Текущая эпоха доступа заведения.", "example": 1 }
expiresAtОбязательно: Текущее время окончания участия в сессии.
string · date-time
Полное определение
{ "type": "string", "format": "date-time", "description": "Текущее время окончания участия в сессии.", "example": "2026-12-31T18:00:00.000Z" }

Полное определение

{
  "type": "object",
  "properties": {
    "membershipId": {
      "type": "string",
      "format": "uuid",
      "description": "Текущее предоставленное участие в сессии.",
      "example": "4db41e65-a63b-4932-883c-e6c4306ce684"
    },
    "tableSessionId": {
      "type": "string",
      "format": "uuid",
      "description": "Основная сессия обслуживания, принадлежащая гостю.",
      "example": "9b456a94-f735-466f-84ba-67aa863b2905"
    },
    "tableSessionGuestId": {
      "type": "string",
      "format": "uuid",
      "description": "Операционный слот гостя, принадлежащий вызывающему.",
      "example": "cbca9476-6eef-441b-874e-918d61f54560"
    },
    "guestLabel": {
      "type": "string",
      "description": "Отображаемая подпись операционного слота вызывающего гостя.",
      "example": "1.000"
    },
    "tableLabel": {
      "type": "string",
      "description": "Отображаемое обозначение текущего обслуживаемого стола.",
      "example": "example"
    },
    "paymentScope": {
      "type": "string",
      "enum": [
        "DISABLED",
        "ASSIGNED_ITEMS",
        "SESSION_BILL"
      ],
      "description": "Текущая подсказка политики заведения о доступности платёжного входа. Финансовые действия требуют текущих полномочий нативного платёжного источника и отдельного явного согласия.",
      "example": "DISABLED"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Текущая ревизия участия в сессии.",
      "example": 1
    },
    "accessEpoch": {
      "type": "integer",
      "minimum": 1,
      "description": "Текущая эпоха доступа сессии.",
      "example": 1
    },
    "policyAccessEpoch": {
      "type": "integer",
      "minimum": 1,
      "description": "Текущая эпоха доступа заведения.",
      "example": 1
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Текущее время окончания участия в сессии.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "description": "Безопасное текущее представление участия вызывающего гостя в Hallify: операционный слот, подписи стола, эпохи доступа и исходный срок предоставленного участия.",
  "required": [
    "membershipId",
    "tableSessionId",
    "tableSessionGuestId",
    "guestLabel",
    "tableLabel",
    "paymentScope",
    "revision",
    "accessEpoch",
    "policyAccessEpoch",
    "expiresAt"
  ],
  "example": {
    "membershipId": "4db41e65-a63b-4932-883c-e6c4306ce684",
    "tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
    "tableSessionGuestId": "cbca9476-6eef-441b-874e-918d61f54560",
    "guestLabel": "1.000",
    "tableLabel": "example",
    "paymentScope": "DISABLED",
    "revision": 1,
    "accessEpoch": 1,
    "policyAccessEpoch": 1,
    "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"
}