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

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

Получить свой счёт лояльности

GET/guest-portal/loyalty

Возвращает свою регистрацию в программе лояльности, баланс баллов, уровень, сроки действия и доступную сводку проводок.

Авторизация

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

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

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

Параметры

Параметров пути, запроса и обычных заголовков нет. Проверьте авторизацию и тело запроса ниже.

Ответы

200Возвращает текущее гостевое представление счёта лояльности.
GuestLoyaltyWorkspaceDto
Полное определение
{
  "$ref": "#/components/schemas/GuestLoyaltyWorkspaceDto"
}
Пример ответа · 200 · application/json
{
  "adjustments": [
    {
      "id": "69437603-0ae1-4d42-848b-150f80c54e15",
      "points": 0,
      "reason": "Synthetic example",
      "status": "PENDING",
      "revision": 1,
      "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
      "requestedAt": "2026-01-15T12:00:00.000Z"
    }
  ]
}
401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ guestPortalToken на границе владеющего домена.
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"
}

Схемы

GuestLoyaltyWorkspaceDto

Возвращает текущее гостевое представление счёта лояльности.

programНеобязательно

Вложенные сведения program; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.

object · null
Полное определение
{
  "type": "object",
  "required": [
    "id",
    "name",
    "status",
    "pointsName",
    "currency",
    "pointsPerCurrencyUnit",
    "redemptionValuePerPoint",
    "revision",
    "tiers"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `id`.",
      "example": "222a791a-08cc-49d5-8a38-85ae79bc2a8f"
    },
    "venueId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "UUID Hallify для `venueId`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
    },
    "name": {
      "type": "string",
      "description": "Понятное человеку значение `name`.",
      "example": "Example name"
    },
    "status": {
      "type": "string",
      "enum": [
        "DRAFT",
        "ACTIVE",
        "PAUSED",
        "ARCHIVED"
      ],
      "description": "Текущий статус жизненного цикла `status`; допустимые значения: DRAFT, ACTIVE, PAUSED, ARCHIVED.",
      "example": "DRAFT"
    },
    "pointsName": {
      "type": "string",
      "description": "Понятное человеку значение `pointsName`.",
      "example": "Example name"
    },
    "currency": {
      "type": "string",
      "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
      "example": "GEL"
    },
    "pointsPerCurrencyUnit": {
      "type": "string",
      "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
      "example": "GEL"
    },
    "redemptionValuePerPoint": {
      "type": "string",
      "description": "Стоимость погашения одного балла `redemptionValuePerPoint`.",
      "example": "example"
    },
    "pointsExpiryDays": {
      "type": "integer",
      "nullable": true,
      "description": "Целочисленное значение `pointsExpiryDays`. Null означает отсутствие записанного значения в этом представлении.",
      "example": 0
    },
    "revision": {
      "type": "integer",
      "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
      "example": 1
    },
    "tiers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "minimumLifetimePoints",
          "isActive",
          "revision"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID Hallify для `id`.",
            "example": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb"
          },
          "name": {
            "type": "string",
            "description": "Понятное человеку значение `name`.",
            "example": "Example name"
          },
          "minimumLifetimePoints": {
            "type": "integer",
            "description": "Целочисленное значение `minimumLifetimePoints`.",
            "example": 0
          },
          "benefits": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/JsonValue"
            },
            "nullable": true,
            "description": "Определения предоставленных преимуществ `benefits`. Null означает отсутствие записанного значения в этом представлении.",
            "example": {
              "exampleKey": "example"
            }
          },
          "isActive": {
            "type": "boolean",
            "description": "Признак активности `isActive` и доступности для документированного использования; false означает неактивное состояние.",
            "example": true
          },
          "revision": {
            "type": "integer",
            "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
            "example": 1
          }
        },
        "example": {
          "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
          "name": "Example name",
          "minimumLifetimePoints": 0,
          "isActive": true,
          "revision": 1
        }
      },
      "description": "Коллекция `tiers` в составе представления.",
      "example": [
        {
          "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
          "name": "Example name",
          "minimumLifetimePoints": 0,
          "isActive": true,
          "revision": 1
        }
      ]
    }
  },
  "nullable": true,
  "description": "Вложенные сведения `program`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
  "example": {
    "id": "222a791a-08cc-49d5-8a38-85ae79bc2a8f",
    "name": "Example name",
    "status": "DRAFT",
    "pointsName": "Example name",
    "currency": "GEL",
    "pointsPerCurrencyUnit": "GEL",
    "redemptionValuePerPoint": "example",
    "revision": 1,
    "tiers": [
      {
        "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
        "name": "Example name",
        "minimumLifetimePoints": 0,
        "isActive": true,
        "revision": 1
      }
    ]
  }
}
accountНеобязательно

Вложенные сведения account; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.

object · null
Полное определение
{
  "type": "object",
  "nullable": true,
  "required": [
    "id",
    "pointsBalance",
    "lifetimePoints",
    "revision",
    "enrolledAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `id`.",
      "example": "f9b88121-702a-4576-8ac2-dd88ef58b3f0"
    },
    "pointsBalance": {
      "type": "integer",
      "description": "Целочисленное значение `pointsBalance`.",
      "example": 0
    },
    "lifetimePoints": {
      "type": "integer",
      "description": "Целочисленное значение `lifetimePoints`.",
      "example": 0
    },
    "revision": {
      "type": "integer",
      "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
      "example": 1
    },
    "enrolledAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `enrolledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "lastActivityAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Время `lastActivityAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "tier": {
      "required": [
        "id",
        "name",
        "minimumLifetimePoints",
        "benefits"
      ],
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "dc560371-b113-4aec-80d5-67bd830de231"
        },
        "name": {
          "type": "string",
          "description": "Понятное человеку значение `name`.",
          "example": "Example name"
        },
        "minimumLifetimePoints": {
          "type": "integer",
          "description": "Целочисленное значение `minimumLifetimePoints`.",
          "example": 0
        },
        "benefits": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "nullable": true,
          "description": "Определения предоставленных преимуществ `benefits`. Null означает отсутствие записанного значения в этом представлении.",
          "example": {
            "exampleKey": "example"
          }
        }
      },
      "description": "Вложенные сведения `tier`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
      "example": {
        "id": "dc560371-b113-4aec-80d5-67bd830de231",
        "name": "Example name",
        "minimumLifetimePoints": 0,
        "benefits": null
      }
    }
  },
  "description": "Вложенные сведения `account`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
  "example": {
    "id": "f9b88121-702a-4576-8ac2-dd88ef58b3f0",
    "pointsBalance": 0,
    "lifetimePoints": 0,
    "revision": 1,
    "enrolledAt": "2026-01-15T12:00:00.000Z"
  }
}
adjustmentsОбязательно

Коллекция adjustments в составе представления.

array
Полное определение
{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "points",
      "reason",
      "status",
      "revision",
      "requestedById",
      "requestedAt"
    ],
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid",
        "description": "UUID Hallify для `id`.",
        "example": "69437603-0ae1-4d42-848b-150f80c54e15"
      },
      "points": {
        "type": "integer",
        "description": "Целочисленное значение `points`.",
        "example": 0
      },
      "reason": {
        "type": "string",
        "description": "Причина `reason`, введённая человеком и сохранённая как обоснование решения или свидетельство аудита.",
        "example": "Synthetic example"
      },
      "status": {
        "type": "string",
        "enum": [
          "PENDING",
          "APPROVED",
          "REJECTED",
          "APPLIED"
        ],
        "description": "Текущий статус жизненного цикла `status`; допустимые значения: PENDING, APPROVED, REJECTED, APPLIED.",
        "example": "PENDING"
      },
      "revision": {
        "type": "integer",
        "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
        "example": 1
      },
      "requestedById": {
        "type": "string",
        "format": "uuid",
        "description": "UUID Hallify пользователя, запросившего корректировку баллов лояльности.",
        "example": "e84b4c3f-5e8d-4601-8a63-dafba13b902d"
      },
      "decidedById": {
        "type": "string",
        "format": "uuid",
        "nullable": true,
        "description": "UUID Hallify пользователя, принявшего решение о корректировке баллов лояльности. Null означает отсутствие записанного значения в этом представлении.",
        "example": "12f638d0-9411-4c61-8f2d-aa3e985672c0"
      },
      "requestedAt": {
        "type": "string",
        "format": "date-time",
        "description": "Время `requestedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
        "example": "2026-01-15T12:00:00.000Z"
      },
      "decidedAt": {
        "type": "string",
        "format": "date-time",
        "nullable": true,
        "description": "Время `decidedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
        "example": "2026-01-15T12:00:00.000Z"
      }
    },
    "example": {
      "id": "69437603-0ae1-4d42-848b-150f80c54e15",
      "points": 0,
      "reason": "Synthetic example",
      "status": "PENDING",
      "revision": 1,
      "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
      "requestedAt": "2026-01-15T12:00:00.000Z"
    }
  },
  "description": "Коллекция `adjustments` в составе представления.",
  "example": [
    {
      "id": "69437603-0ae1-4d42-848b-150f80c54e15",
      "points": 0,
      "reason": "Synthetic example",
      "status": "PENDING",
      "revision": 1,
      "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
      "requestedAt": "2026-01-15T12:00:00.000Z"
    }
  ]
}
Полное определение
{
  "type": "object",
  "required": [
    "adjustments"
  ],
  "properties": {
    "program": {
      "type": "object",
      "required": [
        "id",
        "name",
        "status",
        "pointsName",
        "currency",
        "pointsPerCurrencyUnit",
        "redemptionValuePerPoint",
        "revision",
        "tiers"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "222a791a-08cc-49d5-8a38-85ae79bc2a8f"
        },
        "venueId": {
          "type": "string",
          "format": "uuid",
          "nullable": true,
          "description": "UUID Hallify для `venueId`. Null означает отсутствие записанного значения в этом представлении.",
          "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
        },
        "name": {
          "type": "string",
          "description": "Понятное человеку значение `name`.",
          "example": "Example name"
        },
        "status": {
          "type": "string",
          "enum": [
            "DRAFT",
            "ACTIVE",
            "PAUSED",
            "ARCHIVED"
          ],
          "description": "Текущий статус жизненного цикла `status`; допустимые значения: DRAFT, ACTIVE, PAUSED, ARCHIVED.",
          "example": "DRAFT"
        },
        "pointsName": {
          "type": "string",
          "description": "Понятное человеку значение `pointsName`.",
          "example": "Example name"
        },
        "currency": {
          "type": "string",
          "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
          "example": "GEL"
        },
        "pointsPerCurrencyUnit": {
          "type": "string",
          "description": "Код валюты ISO 4217 в `currency` для денежных значений этого представления.",
          "example": "GEL"
        },
        "redemptionValuePerPoint": {
          "type": "string",
          "description": "Стоимость погашения одного балла `redemptionValuePerPoint`.",
          "example": "example"
        },
        "pointsExpiryDays": {
          "type": "integer",
          "nullable": true,
          "description": "Целочисленное значение `pointsExpiryDays`. Null означает отсутствие записанного значения в этом представлении.",
          "example": 0
        },
        "revision": {
          "type": "integer",
          "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
          "example": 1
        },
        "tiers": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "name",
              "minimumLifetimePoints",
              "isActive",
              "revision"
            ],
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "UUID Hallify для `id`.",
                "example": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb"
              },
              "name": {
                "type": "string",
                "description": "Понятное человеку значение `name`.",
                "example": "Example name"
              },
              "minimumLifetimePoints": {
                "type": "integer",
                "description": "Целочисленное значение `minimumLifetimePoints`.",
                "example": 0
              },
              "benefits": {
                "type": "object",
                "additionalProperties": {
                  "$ref": "#/components/schemas/JsonValue"
                },
                "nullable": true,
                "description": "Определения предоставленных преимуществ `benefits`. Null означает отсутствие записанного значения в этом представлении.",
                "example": {
                  "exampleKey": "example"
                }
              },
              "isActive": {
                "type": "boolean",
                "description": "Признак активности `isActive` и доступности для документированного использования; false означает неактивное состояние.",
                "example": true
              },
              "revision": {
                "type": "integer",
                "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
                "example": 1
              }
            },
            "example": {
              "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
              "name": "Example name",
              "minimumLifetimePoints": 0,
              "isActive": true,
              "revision": 1
            }
          },
          "description": "Коллекция `tiers` в составе представления.",
          "example": [
            {
              "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
              "name": "Example name",
              "minimumLifetimePoints": 0,
              "isActive": true,
              "revision": 1
            }
          ]
        }
      },
      "nullable": true,
      "description": "Вложенные сведения `program`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
      "example": {
        "id": "222a791a-08cc-49d5-8a38-85ae79bc2a8f",
        "name": "Example name",
        "status": "DRAFT",
        "pointsName": "Example name",
        "currency": "GEL",
        "pointsPerCurrencyUnit": "GEL",
        "redemptionValuePerPoint": "example",
        "revision": 1,
        "tiers": [
          {
            "id": "a088d985-d2c9-4968-8593-7fbdfd8fa9cb",
            "name": "Example name",
            "minimumLifetimePoints": 0,
            "isActive": true,
            "revision": 1
          }
        ]
      }
    },
    "account": {
      "type": "object",
      "nullable": true,
      "required": [
        "id",
        "pointsBalance",
        "lifetimePoints",
        "revision",
        "enrolledAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID Hallify для `id`.",
          "example": "f9b88121-702a-4576-8ac2-dd88ef58b3f0"
        },
        "pointsBalance": {
          "type": "integer",
          "description": "Целочисленное значение `pointsBalance`.",
          "example": 0
        },
        "lifetimePoints": {
          "type": "integer",
          "description": "Целочисленное значение `lifetimePoints`.",
          "example": 0
        },
        "revision": {
          "type": "integer",
          "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
          "example": 1
        },
        "enrolledAt": {
          "type": "string",
          "format": "date-time",
          "description": "Время `enrolledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "lastActivityAt": {
          "type": "string",
          "format": "date-time",
          "nullable": true,
          "description": "Время `lastActivityAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "tier": {
          "required": [
            "id",
            "name",
            "minimumLifetimePoints",
            "benefits"
          ],
          "type": "object",
          "nullable": true,
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid",
              "description": "UUID Hallify для `id`.",
              "example": "dc560371-b113-4aec-80d5-67bd830de231"
            },
            "name": {
              "type": "string",
              "description": "Понятное человеку значение `name`.",
              "example": "Example name"
            },
            "minimumLifetimePoints": {
              "type": "integer",
              "description": "Целочисленное значение `minimumLifetimePoints`.",
              "example": 0
            },
            "benefits": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/components/schemas/JsonValue"
              },
              "nullable": true,
              "description": "Определения предоставленных преимуществ `benefits`. Null означает отсутствие записанного значения в этом представлении.",
              "example": {
                "exampleKey": "example"
              }
            }
          },
          "description": "Вложенные сведения `tier`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
          "example": {
            "id": "dc560371-b113-4aec-80d5-67bd830de231",
            "name": "Example name",
            "minimumLifetimePoints": 0,
            "benefits": null
          }
        }
      },
      "description": "Вложенные сведения `account`; состав полей указан в схеме. Null означает отсутствие записанного значения в этом представлении.",
      "example": {
        "id": "f9b88121-702a-4576-8ac2-dd88ef58b3f0",
        "pointsBalance": 0,
        "lifetimePoints": 0,
        "revision": 1,
        "enrolledAt": "2026-01-15T12:00:00.000Z"
      }
    },
    "adjustments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "points",
          "reason",
          "status",
          "revision",
          "requestedById",
          "requestedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID Hallify для `id`.",
            "example": "69437603-0ae1-4d42-848b-150f80c54e15"
          },
          "points": {
            "type": "integer",
            "description": "Целочисленное значение `points`.",
            "example": 0
          },
          "reason": {
            "type": "string",
            "description": "Причина `reason`, введённая человеком и сохранённая как обоснование решения или свидетельство аудита.",
            "example": "Synthetic example"
          },
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "APPROVED",
              "REJECTED",
              "APPLIED"
            ],
            "description": "Текущий статус жизненного цикла `status`; допустимые значения: PENDING, APPROVED, REJECTED, APPLIED.",
            "example": "PENDING"
          },
          "revision": {
            "type": "integer",
            "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
            "example": 1
          },
          "requestedById": {
            "type": "string",
            "format": "uuid",
            "description": "UUID Hallify пользователя, запросившего корректировку баллов лояльности.",
            "example": "e84b4c3f-5e8d-4601-8a63-dafba13b902d"
          },
          "decidedById": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "UUID Hallify пользователя, принявшего решение о корректировке баллов лояльности. Null означает отсутствие записанного значения в этом представлении.",
            "example": "12f638d0-9411-4c61-8f2d-aa3e985672c0"
          },
          "requestedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Время `requestedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
            "example": "2026-01-15T12:00:00.000Z"
          },
          "decidedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Время `decidedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
            "example": "2026-01-15T12:00:00.000Z"
          }
        },
        "example": {
          "id": "69437603-0ae1-4d42-848b-150f80c54e15",
          "points": 0,
          "reason": "Synthetic example",
          "status": "PENDING",
          "revision": 1,
          "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
          "requestedAt": "2026-01-15T12:00:00.000Z"
        }
      },
      "description": "Коллекция `adjustments` в составе представления.",
      "example": [
        {
          "id": "69437603-0ae1-4d42-848b-150f80c54e15",
          "points": 0,
          "reason": "Synthetic example",
          "status": "PENDING",
          "revision": 1,
          "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
          "requestedAt": "2026-01-15T12:00:00.000Z"
        }
      ]
    }
  },
  "description": "Возвращает текущее гостевое представление счёта лояльности.",
  "example": {
    "adjustments": [
      {
        "id": "69437603-0ae1-4d42-848b-150f80c54e15",
        "points": 0,
        "reason": "Synthetic example",
        "status": "PENDING",
        "revision": 1,
        "requestedById": "e84b4c3f-5e8d-4601-8a63-dafba13b902d",
        "requestedAt": "2026-01-15T12:00:00.000Z"
      }
    ]
  }
}
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"
}
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"
  }
}

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

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