Перейти к содержимому

Словарь причин изъятия

GET
/api/v2/salons/{salon_id}/photos/removal-reasons
curl --request GET \
--url https://app.photo-otchet.ru/api/v2/salons/1/photos/removal-reasons \
--header 'Authorization: Bearer <token>'

Набор живёт в коде: код причины, подпись для мастера и нужен ли текст. Берётся один раз — например, вместе с политиками при входе — и сопоставляется по коду; сам код показывать не нужно.

salon_id
required
Salon Id

Салон

integer
>= 1

Салон

Набор причин изъятия с подписями

Media type application/json
Response Listremovalreasons
Array<object>
RemovalReasonInfo

Причина изъятия для интерфейса: код, подпись и нужен ли текст.

Отдаётся словарём (GET /photos/removal-reasons), потому что набор живёт в коде: клиент берёт подписи один раз и сопоставляет по коду. Сам код он не показывает — незнакомый код это повод показать removal_note или общую фразу.

object
reason
required
RemovalReason

Почему фото изъято на модерацию.

Три значения, а не пятнадцать: набор нужен затем, чтобы плашка мастеру была понятной и не грубой, а подробности живут в removal_note («что именно не так»). Дробить стоит тогда, когда у категории появится другое поведение, а не другой текст.

string
Allowed values: third_party complaint rules
label
required
Label
string
needs_note
required
Needs Note
boolean

Пример

[
{
"reason": "third_party"
}
]

Нет действующего входа: нет куки или токена, сессия истекла, токен отозван

Media type application/json
ErrorResponse

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

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Срок салона кончился: reason: salon_expired, в теле state и paid_until

Media type application/json
ErrorResponse

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

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Прав на это действие нет: не хватает политики или запрещён способ входа

Media type application/json
ErrorResponse

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

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Салона нет, он вне объёма сессии или токена, членство выключено — один ответ на все случаи, иначе по разнице читалось бы, в каких салонах состоит учётка

Media type application/json
ErrorResponse

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

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Запрос не прошёл проверку схемы

Media type application/json
ValidationErrorResponse

Запрос не прошёл проверку схемы: единственный отказ, у которого detail — массив.

У доменных отказов detail строкой и reason: invalid (ErrorResponse), так что различать формы можно по reason, а не по типу detail.

object
detail
required
Detail
Array<object>
ValidationItem

Одна ошибка схемы запроса.

object
loc
required
Loc

Где именно: body, имя поля, индекс в списке

Array<string>
type
required
Type

Вид ошибки от pydantic: value_error, int_parsing, missing…

string
msg
required
Msg

Текст ошибки

string
for_user
required
For User

Текст написан для человека и готов к показу (value_error — наш валидатор). false — встроенный текст pydantic на английском: показывайте свою формулировку

boolean
reason
Reason
string
default: validation
Allowed value: validation

Пример

{
"reason": "validation"
}

Салон заблокирован оператором: reason: salon_blocked, причина в blocked_reason

Media type application/json
ErrorResponse

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

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}