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

{
  "type": "object",
  "required": [
    "identityRevision",
    "policyVersion",
    "consents",
    "marketingPreference"
  ],
  "properties": {
    "identityRevision": {
      "type": "integer",
      "description": "Монотонно возрастающая ревизия `identityRevision` для оптимистичного контроля конкурентных изменений.",
      "example": 1
    },
    "policyVersion": {
      "type": "string",
      "description": "Версия политики `policyVersion`.",
      "example": "example"
    },
    "consents": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "purpose",
          "status",
          "captureSource",
          "policyVersion",
          "effectiveAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID Hallify для `id`.",
            "example": "4aebbd5f-0775-4a9f-8cdf-18303bfc76dd"
          },
          "purpose": {
            "type": "string",
            "enum": [
              "MARKETING_EMAIL",
              "MARKETING_SMS",
              "MARKETING_PHONE",
              "MARKETING_WHATSAPP",
              "PROFILING"
            ],
            "description": "Допустимые значения `purpose`: MARKETING_EMAIL, MARKETING_SMS, MARKETING_PHONE, MARKETING_WHATSAPP, PROFILING.",
            "example": "MARKETING_EMAIL"
          },
          "status": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "OPTED_IN",
              "OPTED_OUT"
            ],
            "description": "Текущий статус жизненного цикла `status`; допустимые значения: UNKNOWN, OPTED_IN, OPTED_OUT.",
            "example": "UNKNOWN"
          },
          "captureSource": {
            "type": "string",
            "enum": [
              "STAFF",
              "GUEST_PORTAL",
              "RESERVATION",
              "IMPORT",
              "PROVIDER"
            ],
            "description": "Допустимые значения `captureSource`: STAFF, GUEST_PORTAL, RESERVATION, IMPORT, PROVIDER.",
            "example": "STAFF"
          },
          "policyVersion": {
            "type": "string",
            "description": "Версия политики `policyVersion`.",
            "example": "example"
          },
          "evidence": {
            "type": "string",
            "nullable": true,
            "description": "Подтверждающие сведения `evidence`, введённые человеком для аудита или последующей проверки. Null означает отсутствие записанного значения в этом представлении.",
            "example": "example"
          },
          "effectiveAt": {
            "type": "string",
            "format": "date-time",
            "description": "Время `effectiveAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
            "example": "2026-01-15T12:00:00.000Z"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Время `expiresAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
            "example": "2026-12-31T18:00:00.000Z"
          }
        },
        "example": {
          "id": "4aebbd5f-0775-4a9f-8cdf-18303bfc76dd",
          "purpose": "MARKETING_EMAIL",
          "status": "UNKNOWN",
          "captureSource": "STAFF",
          "policyVersion": "example",
          "effectiveAt": "2026-01-15T12:00:00.000Z"
        }
      },
      "description": "Коллекция `consents` в составе представления.",
      "example": [
        {
          "id": "4aebbd5f-0775-4a9f-8cdf-18303bfc76dd",
          "purpose": "MARKETING_EMAIL",
          "status": "UNKNOWN",
          "captureSource": "STAFF",
          "policyVersion": "example",
          "effectiveAt": "2026-01-15T12:00:00.000Z"
        }
      ]
    },
    "marketingPreference": {
      "type": "object",
      "required": [
        "frequency",
        "preferredChannels",
        "topics",
        "revision"
      ],
      "properties": {
        "frequency": {
          "type": "string",
          "enum": [
            "TRANSACTIONAL_ONLY",
            "OCCASIONAL",
            "WEEKLY",
            "MONTHLY"
          ],
          "description": "Допустимые значения `frequency`: TRANSACTIONAL_ONLY, OCCASIONAL, WEEKLY, MONTHLY.",
          "example": "TRANSACTIONAL_ONLY"
        },
        "preferredChannels": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EMAIL",
              "SMS",
              "PHONE",
              "WHATSAPP"
            ],
            "example": "EMAIL"
          },
          "description": "Коллекция `preferredChannels` в составе представления.",
          "example": [
            "EMAIL"
          ]
        },
        "topics": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "example"
          },
          "description": "Коллекция `topics` в составе представления.",
          "example": [
            "example"
          ]
        },
        "suppressedUntil": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Время `suppressedUntil` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "revision": {
          "type": "integer",
          "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
          "example": 1
        }
      },
      "description": "Вложенные сведения `marketingPreference`; состав полей указан в схеме.",
      "example": {
        "frequency": "TRANSACTIONAL_ONLY",
        "preferredChannels": [
          "EMAIL"
        ],
        "topics": [
          "example"
        ],
        "revision": 1
      }
    }
  },
  "description": "Возвращает текущие согласия, предпочтения каналов, источники и время решений.",
  "example": {
    "identityRevision": 1,
    "policyVersion": "example",
    "consents": [
      {
        "id": "4aebbd5f-0775-4a9f-8cdf-18303bfc76dd",
        "purpose": "MARKETING_EMAIL",
        "status": "UNKNOWN",
        "captureSource": "STAFF",
        "policyVersion": "example",
        "effectiveAt": "2026-01-15T12:00:00.000Z"
      }
    ],
    "marketingPreference": {
      "frequency": "TRANSACTIONAL_ONLY",
      "preferredChannels": [
        "EMAIL"
      ],
      "topics": [
        "example"
      ],
      "revision": 1
    }
  }
}

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

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

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