Получает фото

Получает фото.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/photos

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании, используемый в запросах к API Мониторинга.

Query parameters

Name	Description
courier_id	Type: integer<int64> ID курьера.
ids	Type: string<list_of_integers> Список ID фото.
order_ids	Type: string<list_of_integers> Список ID заказов.
page	Type: integer Номер страницы. Каждая страница содержит `per_page` объектов. Default: `1` Min value: `1`
per_page	Type: integer<int32> Количество фото на страницу. Default: `100` Min value: `1` Max value: `2000`
route_ids	Type: string<list_of_integers> Список ID маршрутов.
tag	Type: string Тег фото.

Responses

200 OK

Список фото.

Body

application/json

[
    {
        "id": "string",
        "link": "string",
        "created_at": "string",
        "route_id": "string",
        "courier_id": "string",
        "order_id": "string",
        "tags": [
            "string"
        ],
        "comment": "string",
        "ttl_s": 0,
        "point": {
            "lat": 0,
            "lon": 0
        }
    }
]

PhotosGetList[]

PhotosGetList

Name	Description
comment	Type: string Комментарий к фото.
courier_id	Type: string ID курьера.
created_at	Type: string<datetime> Дата и время загрузки фото в формате ISO 8601. Пример - '2018-09-06T10:15:00+03:00'
id	Type: string ID фото.
link	Type: string Ссылка на фото.
order_id	Type: string ID заказа.
point	Type: PhotosGet_point Позиция, где было сделано фото.
route_id	Type: string ID маршрута.
tags	Type: string[] Тэги к фото.
ttl_s	Type: integer Время гарантированного хранения информации о фото в секундах.

PhotosGet_point

Позиция, где было сделано фото.

Name

Description

lat*

Type: number<float>

Широта позиции точки.

lon*

Type: number<float>

Долгота позиции точки.

401 Unauthorized

Ошибка авторизации.

403 Forbidden

Ошибка доступа.

404 Not Found

Указанные объекты не найдены.

422 Unprocessable Entity

Неправильный ввод.

500 Internal Server Error

Ошибка сервера при обработке запроса.

Was the article helpful?

Обзор