Получить свой гостевой профиль

{
  "type": "object",
  "required": [
    "guest"
  ],
  "properties": {
    "venue": {
      "required": [
        "id",
        "name",
        "currency"
      ],
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0"
        },
        "name": {
          "type": "string",
          "description": "Понятное человеку значение `name`.",
          "example": "Example name"
        },
        "currency": {
          "type": "string",
          "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
          "example": "GEL"
        }
      },
      "description": "Вложенные сведения `venue`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
      "example": {
        "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
        "name": "Example name",
        "currency": "GEL"
      }
    },
    "guest": {
      "type": "object",
      "required": [
        "id",
        "identityId",
        "displayName",
        "revision",
        "identityRevision"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe"
        },
        "identityId": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `identityId`.",
          "example": "68927ddd-82be-42e0-8918-ef5107d35a10"
        },
        "displayName": {
          "type": "string",
          "description": "Понятное человеку значение `displayName`.",
          "example": "Example name"
        },
        "givenName": {
          "type": "string",
          "nullable": true,
          "description": "Понятное человеку значение `givenName`. Null означает отсутствие записанного значения в этом представлении.",
          "example": "Example name"
        },
        "familyName": {
          "type": "string",
          "nullable": true,
          "description": "Понятное человеку значение `familyName`. Null означает отсутствие записанного значения в этом представлении.",
          "example": "Example name"
        },
        "email": {
          "type": "string",
          "nullable": true,
          "description": "Адрес электронной почты `email`. Null означает отсутствие записанного значения в этом представлении.",
          "format": "email",
          "example": "user@example.test"
        },
        "phone": {
          "type": "string",
          "nullable": true,
          "description": "Номер телефона `phone`. Null означает отсутствие записанного значения в этом представлении.",
          "example": "+995555000000"
        },
        "preferredLanguage": {
          "type": "string",
          "nullable": true,
          "description": "Предпочтительный языковой тег BCP 47 в `preferredLanguage` для общения с гостем или сотрудником. Null означает отсутствие записанного значения в этом представлении.",
          "example": "en"
        },
        "defaultPartySize": {
          "type": "integer",
          "nullable": true,
          "description": "Целочисленное значение `defaultPartySize`. Null означает отсутствие записанного значения в этом представлении.",
          "example": 0
        },
        "revision": {
          "type": "integer",
          "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
          "example": 1
        },
        "identityRevision": {
          "type": "integer",
          "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
          "example": 1
        }
      },
      "description": "Вложенные сведения `guest`; состав полей указан в схеме.",
      "example": {
        "id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe",
        "identityId": "68927ddd-82be-42e0-8918-ef5107d35a10",
        "displayName": "Example name",
        "revision": 1,
        "identityRevision": 1
      }
    }
  },
  "description": "Возвращает профиль гостя, контекст заведения и ревизию редактируемых полей.",
  "example": {
    "guest": {
      "id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe",
      "identityId": "68927ddd-82be-42e0-8918-ef5107d35a10",
      "displayName": "Example name",
      "revision": 1,
      "identityRevision": 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"
}