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

Карточка фото

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

Карточка со ссылками, тегами и мастером.

У необработанного фото urls пусты: ссылки появятся, когда обработка закончится. Отдельного кода «ещё не готово» нет — статус в теле говорит об этом точнее.

photo_id
required
Photo Id

Работа салона

integer
>= 1

Работа салона

salon_id
required
Salon Id

Салон

integer
>= 1

Салон

Карточка работы

Media type application/json
PhotoView

Фото в выдаче: карточка со ссылками, чей это мастер и оба вида тегов.

master_id и master_name берутся от владельца (photos.owner_id), а не от привязки к портфолио: владелец есть у любого фото, а привязки может не быть вовсе.

Оба набора тегов заполняются только по своей политике на чтение: tags — по tags:read, service_tags — по service_tags:read. Это не про удобство, а часть правила: служебные метки мастеру не видны нигде, а теги без права на справочник нечем ни отфильтровать, ни выбрать при разметке, так что показывать их в выдаче незачем. Пустой список значит «права нет», а не «тегов нет».

Поля изъятия (removed_at, removal_reason, removal_note, purge_after) лежат в основе карточки — ResponseDownloadUrl, — а не здесь: плашка нужна во всех выдачах, включая экран дня и портфолио.

object
id
required
Id
integer
created_at
required
Created At
string format: date-time
can_delete
required
Can Delete
boolean
status
required
PhotoStatus

Что с файлом работы: ссылка выдана, файл загружен, обрабатывается, готов или не получился.

string
Allowed values: pending loaded processing ready failed
urls
required
Any of:
PhotoDownloadLink

Ссылки на файл работы: сам кадр и превью.

Ссылки подписанные и временные — живут около суток (точный срок настраивается на сервере). Хранить их у себя нельзя: по истёкшей хранилище откажет. Нужна снова — запросите карточку работы, ссылка придёт новая.

object
full
required
Full

Полный кадр

string format: uri
>= 1 characters <= 2083 characters
thumb
required
Thumb

Превью: им заполняют сетки и списки

string format: uri
>= 1 characters <= 2083 characters
removed_at
Any of:
string format: date-time
removal_reason
Any of:
string
removal_note
Any of:
string
removal_marks
Any of:
RemovalMarks

Разметка вердикта целиком: версия формата и список фигур.

Пустой список принимается и означает «разметки нет»: клиенту проще прислать пустое, чем решать, опускать ли поле, а нам — записать null вместо него (см. is_empty).

object
v
required
V

Версия формата разметки; сейчас 1

integer
Allowed value: 1
shapes
required
Shapes

Фигуры на кадре, не больше 20

Array
<= 20 items
One of: discriminator: type
BoxShape

Фигура по двум точкам: прямоугольник, эллипс, стрелка, отрезок.

У всех четырёх points — это [x1, y1, x2, y2]. У прямоугольника и эллипса порядок неважен (это углы описывающего прямоугольника), у стрелки значащий: от хвоста к острию.

object
color
MarkColor

Цвет из закрытой палитры

string
default: red
Allowed values: red white black yellow cyan
w
MarkWidth

Толщина линии

string
default: mid
Allowed values: thin mid bold
type
required
Type
string
Allowed values: rect ellipse arrow line
points
required
Points

[x1, y1, x2, y2] в долях кадра; у стрелки — от хвоста к острию

Array<number>
>= 4 items <= 4 items
purge_after
Any of:
string format: date-time
master_id
required
Master Id
integer
master_name
required
Master Name
string
added_at
Any of:
string format: date-time
binding
Any of:
Binding

Где лежит фото. Значения взаимно исключающие: либо портфолио, либо визит, либо нигде.

string
Allowed values: portfolio slot unbound
slot
Any of:
SlotRef

Визит, в котором лежит фото: ровно столько, сколько нужно, чтобы его узнать и привязать замену туда же.

object
id
required
Id
integer
datetime_start
required
Datetime Start
string format: date-time
replacement_ids
Replacement Ids

Фото, загруженные мастером вместо этого — приходят только на вкладках изъятия. Метка справочная: вердикт она не снимает, изъятое возвращает только works:release

Array<integer>
tags
Tags

Теги мастера, по порядку показа

Array<object>
TagResponse

Тег справочника.

object
id
required
Id
integer
name
required
Name
string
sort
required
Sort
integer
archived_at
required
Any of:
string format: date-time
photos
Any of:
integer
group
Any of:
TagGroupRef

Группа тега внутри самого тега: столько, сколько нужно, чтобы его показать и понять, можно ли назначить.

Порядка и числа тегов здесь нет — за ними идут в справочник групп. archived_at есть: тег архивной группы назначать нельзя, и правило читается на клиенте одинаково для обоих случаев — архив у тега или у его группы.

object
id
required
Id
integer
name
required
Name
string
archived_at
required
Any of:
string format: date-time
service_tags
Service Tags

Служебные метки; мастеру пусто

Array<object>
TagResponse

Тег справочника.

object
id
required
Id
integer
name
required
Name
string
sort
required
Sort
integer
archived_at
required
Any of:
string format: date-time
photos
Any of:
integer
group
Any of:
TagGroupRef

Группа тега внутри самого тега: столько, сколько нужно, чтобы его показать и понять, можно ли назначить.

Порядка и числа тегов здесь нет — за ними идут в справочник групп. archived_at есть: тег архивной группы назначать нельзя, и правило читается на клиенте одинаково для обоих случаев — архив у тега или у его группы.

object
id
required
Id
integer
name
required
Name
string
archived_at
required
Any of:
string format: date-time

Пример

{
"status": "pending",
"removal_marks": {
"v": 1,
"shapes": [
{
"color": "red",
"w": "thin",
"type": "rect"
}
]
},
"binding": "portfolio"
}

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

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

Пример

{
"detail": "Фото не найдено"
}

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

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