Справочные подсказки

Operations

Получить справочную подсказку по коду

Request

Возвращает подсказку по code.

Коды подсказок:

cancellation_conditions
- Название в интерфейсе: Условие отмены записи
- Описание: текст с правилами отмены/переноса записи и удержания оплаты.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=532-10834&t=xWyZ3rAllD8FCcOq-4
discount_description
- Название в интерфейсе: Описание скидки
- Описание: текст с пояснением персональной цены с учётом реферальной скидки.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=1296-30787&t=xWyZ3rAllD8FCcOq-4
working_time_description
- Название в интерфейсе: Рабочее время
- Описание: текст с пояснением времени на подготовку рабочего места и отдых.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=1303-32601&t=xWyZ3rAllD8FCcOq-4
breaks_description
- Название в интерфейсе: Перерывы
- Описание: текст с пояснением минимального времени, за которое клиент может записаться.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=1303-32982&t=xWyZ3rAllD8FCcOq-4
price_description
- Название в интерфейсе: Стоимость
- Описание: текст с пояснением постоянной и динамической стоимости.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=3473-27854&t=xWyZ3rAllD8FCcOq-4
analytics_period_description
- Название в интерфейсе: Период аналитики
- Описание: текст с пояснением сравнения с предыдущим периодом такой же длительности.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=3305-58099&t=xWyZ3rAllD8FCcOq-4
finance_total_description
- Название в интерфейсе: Финансы
- Описание: текст с пояснением итоговой суммы с учетом комиссии платформы.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=1696-25560&t=xWyZ3rAllD8FCcOq-4
dynamic_price_time_description
- Название в интерфейсе: Заполнение времени динамической цены
- Описание: текст с пояснением цены для времени, не покрытого диапазонами динамической стоимости.
- Figma: https://www.figma.com/design/bsJd6rFh8FjMkmx9PeIf2C/Felmee?node-id=3713-12918&t=Zy96uToRPhFpShLi-4

Path

codestring, [ 1 .. 128 ] charactersrequired

Стабильный код подсказки.

Example:cancellation_conditions

curl -i -X GET \
  https://felmee.com/api/reference-data/hints/cancellation_conditions

Responses

Reference hint retrieved successfully

Bodyapplication/json

codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"invalid_body""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"

dataobject or null(ReferenceHint)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response

{
  "success": true,
  "message": "Reference hint retrieved successfully",
  "codeError": null,
  "error_code": null,
  "data": {
    "id": 1,
    "code": "cancellation_conditions",
    "text": "Условия отмены:\n12 ч: отмена/перенос бесплатно\n\n12 ч: удерживается 50%\nпри отмене\n\nНеявка: оплата не возвращается"
  }
}