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

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

Отозвать согласие на собственную QR-историю

POST/guest-portal/qr-visits/{associationId}/consent/withdraw

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

Авторизация

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

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

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

Параметры

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

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

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

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

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

Тело запроса

Обязательно

Стабильный UUID команды отзыва и ожидаемая ревизия согласия.

application/json

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

Ответы

200Исходная неизменная квитанция WITHDRAW.
GuestPortalQrConsentDecisionDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPortalQrConsentDecisionDto"
}
Пример ответа · 200 · application/json
{
  "id": "3ad9cce0-1db8-4d2c-8ae3-cb6af5fcd14f",
  "associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
  "revision": 1,
  "decision": "ACCEPT",
  "createdAt": "2026-01-15T10:00:00.000Z"
}
400Некорректные входные данные, изменённый текст согласия или недействительный целевой proof/OTP. Попытки с неверным OTP фиксируются.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401Исходный QR bearer/фактический Origin или текущая сессия Portal недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403Приватная история требует текущего подтверждения контакта. Отзыв согласия не требует свежего OTP.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404Точная принадлежащая гостю association или допустимый исходный запрос недоступны.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
409Конфликт идемпотентности или документированный доменный конфликт конкретной операции
GuestPortalQrCommandConflictDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPortalQrCommandConflictDto"
}
Пример ответа · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "TABLE_PUBLIC_REVISION_CONFLICT",
  "message": "errors:http.conflict",
  "translationKey": "errors:http.conflict"
}
429Канонический бюджет попыток проверки контакта исчерпан.

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

Retry-After

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

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

Схемы

WithdrawGuestPortalQrDto

Добавление отзыва текущим владельцем association; OTP или живая нативная membership не требуются.

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

Стабильный UUID команды; точный повтор возвращает эту исходную квитанцию отзыва даже после последующего повторного согласия.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Стабильный UUID команды; точный повтор возвращает эту исходную квитанцию отзыва даже после последующего повторного согласия.",
  "example": "3e4a6887-ce11-4ae4-8708-9bed02386776"
}
expectedRevisionОбязательно

Ожидаемая ревизия согласия association перед новым решением об отзыве.

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "maximum": 2147483646,
  "description": "Ожидаемая ревизия согласия association перед новым решением об отзыве.",
  "example": 1
}
Полное определение
{
  "type": "object",
  "properties": {
    "commandId": {
      "type": "string",
      "format": "uuid",
      "description": "Стабильный UUID команды; точный повтор возвращает эту исходную квитанцию отзыва даже после последующего повторного согласия.",
      "example": "3e4a6887-ce11-4ae4-8708-9bed02386776"
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646,
      "description": "Ожидаемая ревизия согласия association перед новым решением об отзыве.",
      "example": 1
    }
  },
  "required": [
    "commandId",
    "expectedRevision"
  ],
  "description": "Добавление отзыва текущим владельцем association; OTP или живая нативная membership не требуются.",
  "example": {
    "commandId": "3e4a6887-ce11-4ae4-8708-9bed02386776",
    "expectedRevision": 1
  }
}
GuestPortalQrConsentDecisionDto

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

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

Неизменный UUID квитанции команды согласия.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Неизменный UUID квитанции команды согласия.",
  "example": "3ad9cce0-1db8-4d2c-8ae3-cb6af5fcd14f"
}
associationIdОбязательно

Исходная неизменная QR association.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "Исходная неизменная QR association.",
  "example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631"
}
revisionОбязательно

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

integer
Полное определение
{
  "type": "integer",
  "minimum": 1,
  "description": "Ревизия согласия, изменяемая только добавлением новых решений.",
  "example": 1
}
decisionОбязательно

Решение, записанное этой командой; оно может отличаться от более позднего текущего решения.

string
Полное определение
{
  "type": "string",
  "enum": [
    "ACCEPT",
    "WITHDRAW"
  ],
  "description": "Решение, записанное этой командой; оно может отличаться от более позднего текущего решения.",
  "example": "ACCEPT"
}
createdAtОбязательно

Исходное время решения.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Исходное время решения.",
  "example": "2026-01-15T10:00:00.000Z"
}
Полное определение
{
  "type": "object",
  "description": "Неизменное подтверждение исходной команды согласия, независимое от последующих решений.",
  "additionalProperties": false,
  "required": [
    "id",
    "associationId",
    "revision",
    "decision",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Неизменный UUID квитанции команды согласия.",
      "example": "3ad9cce0-1db8-4d2c-8ae3-cb6af5fcd14f"
    },
    "associationId": {
      "type": "string",
      "format": "uuid",
      "description": "Исходная неизменная QR association.",
      "example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Ревизия согласия, изменяемая только добавлением новых решений.",
      "example": 1
    },
    "decision": {
      "type": "string",
      "enum": [
        "ACCEPT",
        "WITHDRAW"
      ],
      "description": "Решение, записанное этой командой; оно может отличаться от более позднего текущего решения.",
      "example": "ACCEPT"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Исходное время решения.",
      "example": "2026-01-15T10:00:00.000Z"
    }
  },
  "example": {
    "id": "3ad9cce0-1db8-4d2c-8ae3-cb6af5fcd14f",
    "associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
    "revision": 1,
    "decision": "ACCEPT",
    "createdAt": "2026-01-15T10: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"
}
GuestPortalQrCommandConflictDto

Изменённое тело команды или авторизация, выполняемая команда либо устаревшая ревизия согласия с добавлением новых решений. Точные повторы сохраняют полную исходную команду и ключ.

Полное определение
{
  "description": "Изменённое тело команды или авторизация, выполняемая команда либо устаревшая ревизия согласия с добавлением новых решений. Точные повторы сохраняют полную исходную команду и ключ.",
  "example": {
    "statusCode": 409,
    "error": "errors:http.conflict",
    "code": "TABLE_PUBLIC_REVISION_CONFLICT",
    "message": "errors:http.conflict",
    "translationKey": "errors:http.conflict"
  },
  "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",
            "TABLE_PUBLIC_REVISION_CONFLICT",
            "GUEST_PORTAL_QR_REVISION_CONFLICT"
          ],
          "description": "Стабильный код конфликта идемпотентности или доменного конфликта конкретной операции.",
          "example": "IDEMPOTENCY_REQUEST_NOT_READY"
        }
      },
      "example": {
        "code": "IDEMPOTENCY_REQUEST_NOT_READY"
      }
    }
  ]
}

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

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