GET /user/offers/{category}/mark-models

Возвращает список марок/моделей и количество объявлений для каждой марки/модели, которые удовлетворяют заданным условиям.

Формат запроса

GET https://apiauto.ru/1.0/user/offers/{category}/mark-models
? [truck_category=<string>]
& [moto_category=<string>]
& [status=<array[string]>]
& [service=<array[string]>]
& [vin=<array[string]>]
& [mark_model=<array[string]>]
& [price_from=<integer>]
& [price_to=<integer>]
& [section=<string>]
& [create_date_from=<string>]
& [create_date_to=<string>]
& [no_active_services=<boolean>]
& [ban_reason=<array[string]>]

category

Название категории ТС. Допустимые значения:

  • cars — легковые автомобили;
  • moto — мототранспорт;
  • trucks — коммерческий транспорт;
  • all — все категории ТС.

truck_category

Категория коммерческого транспорта.

Допустимые значения:
  • TRUCK — грузовик;
  • LCV — легкий коммерческий транспорт;
  • TRAILER — прицеп;
  • SWAP_BODY — съемный кузов;
  • BUS — автобус;
  • ARTIC — седельный тягач;
  • AGRICULTURAL — сельскохозяйственная;
  • CONSTRUCTION — строительная;
  • AUTOLOADER — автопогрузчик;
  • CRANE — автокран;
  • DREDGE — экскаватор;
  • BULLDOZERS — бульдозер;
  • CRANE_HYDRAULICS — самопогрузчик;
  • MUNICIPAL — коммунальная.

moto_category

Категория мототранспорта.

Допустимые значения:
  • ATV — мотовездеход;
  • MOTORCYCLE — мотоцикл;
  • SCOOTERS — скутер;
  • SNOWMOBILE — снегоход.

status

Статус объявления.

Допустимые значения:
  • active — объявление активно;
  • inactive — объявление скрыто пользователем или службой модерации;
  • banned — объявление или пользователь заблокированы;

Примечание

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

status=active&status=banned

service

Подключенные услуги.

Допустимые значения:
  • all_sale_fresh — поднятие объявления в поиске;
  • all_sale_premium — премиум;
  • all_sale_special — спецпредложение;
  • package_turbo — турбо-продажа;
  • reset — обнуление.

Примечание

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

service=all_sale_special&service=all_sale_premium

vin

VIN-номера.

Примечание

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

vin=skedeP0iddddA0111&vin=sewqfP0irtyuA0222

mark_model

Идентификаторы марки и модели, разделенные закодированным символом «#» (%23), например «MERCEDES%23C_KLASSE». Идентификатор модели может отсутствовать.

Примечание

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

mark_model=MERCEDES%23C_KLASSE&mark_model=HONDA

price_from

Стоимость транспорта в выбранной валюте (например, российский рубль), от.


price_to

Стоимость транспорта в выбранной валюте (например, российский рубль), до.


section

Состояние транспортного средства.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

create_date_from

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, от. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».


create_date_to

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, до. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».


no_active_services

Фильтр. Показывает объявления без примененных услуг.


ban_reason

Причина блокировки объявления. Подробнее с описанием причин блокировки можно ознакомиться в Справочнике причин блокировки.


Заголовки запроса

Заголовок

Описание

x-dealer-id

Идентификатор клиента. Используется для работы под учетной записью агентства.

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
  "mark_models": [
    {
      "mark": "{string}",
      "models": [
        {
          "model": "{string}",
          "offers_count": {integer},
          "human_name": "{string}",
          "category": "{string}"
        }
      ],
      "offers_count": {integer},
      "human_name": "{string}"
    },
    {
      "mark": "{string}",
      "models": [
        {
          "model": "{string}",
          "offers_count": {integer},
          "human_name": "{string}",
          "category": "{string}"
        }
      ],
      "offers_count": {integer},
      "human_name": "{string}"
    }
  ],
  "status": "{string}"
}

mark_models

Массив объектов. Список марок/моделей и количество объявлений для каждой марки/модели.


mark

Код марки.


human_name

Название марки.


models

Массив объектов. Список моделей данной марки для которых есть объявления.


model

Код модели.


human_name

Название марки.


category

Категория ТС.

Допустимые значения:
  • CARS — легковой автомобиль;
  • MOTO — мототранспорт;
  • TRUCKS — коммерческий транспорт.

offers_count

Количество объявлений для данной модели среди объявлений пользователя.


offers_count

Количество объявлений для данной модели среди объявлений пользователя.


status

Статус ответа.


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/user/offers/moto/mark-models?create_date_from=2015-07-08T11%3A29%3A16%2B03%3A00&create_date_to=2018-07-08T11%3A29%3A16%2B03%3A00&no_active_services=false' -H 'x-authorization: 2dtr...er432' -H 'x-session-id: 112_ao...R02Tpv'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 12 Jul 2018 13:30:59 GMT
Content-Type: application/json
Connection: keep-alive

{
  "mark_models": [
    {
      "mark": "BULTACO",
      "models": [
        {
          "model": "ASTRO_50",
          "offers_count": 1,
          "human_name": "Astro 50",
          "category": "MOTO"
        }
      ],
      "offers_count": 1,
      "human_name": "Bultaco"
    },
    {
      "mark": "BMW",
      "models": [
        {
          "model": "F_800_ST",
          "offers_count": 1,
          "human_name": "F 800 ST",
          "category": "MOTO"
        }
      ],
      "offers_count": 1,
      "human_name": "BMW"
    },
    {
      "mark": "APRILIA",
      "models": [
        {
          "model": "DORSODURO",
          "offers_count": 1,
          "human_name": "Dorsoduro 750",
          "category": "MOTO"
        }
      ],
      "offers_count": 1,
      "human_name": "Aprilia"
    }
  ],
  "status": "SUCCESS"
}

Название категории ТС. Допустимые значения:

  • cars — легковые автомобили;
  • moto — мототранспорт;
  • trucks — коммерческий транспорт;
  • all — все категории ТС.

Категория коммерческого транспорта.

Допустимые значения:
  • TRUCK — грузовик;

  • LCV — легкий коммерческий транспорт;

  • TRAILER — прицеп;

  • SWAP_BODY — съемный кузов;

  • BUS — автобус;

  • ARTIC — седельный тягач;

  • AGRICULTURAL — сельскохозяйственная;

  • CONSTRUCTION — строительная;

  • AUTOLOADER — автопогрузчик;

  • CRANE — автокран;

  • DREDGE — экскаватор;

  • BULLDOZERS — бульдозер;

  • CRANE_HYDRAULICS — самопогрузчик;

  • MUNICIPAL — коммунальная.

Категория мототранспорта.

Допустимые значения:
  • ATV — мотовездеход;

  • MOTORCYCLE — мотоцикл;

  • SCOOTERS — скутер;

  • SNOWMOBILE — снегоход.

Статус объявления.

Допустимые значения:
  • active — объявление активно;

  • inactive — объявление неактивно;

  • banned — объявление заблокировано.

Примечание

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

status=active&status=banned

Подключенные услуги.

Допустимые значения:
  • all_sale_fresh — поднятие объявления в поиске;

  • all_sale_premium — премиум;

  • all_sale_special — спецпредложение;

  • package_turbo — турбо-продажа;

  • reset — обнуление.

Примечание

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

service=all_sale_special&service=all_sale_premium 

VIN-номера.

Примечание

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

vin=skedeP0iddddA0111&vin=sewqfP0irtyuA0222

Идентификаторы марки и модели, разделенные закодированным символом «#» (%23), например «MERCEDES%23C_KLASSE». Идентификатор модели может отсутствовать.

Примечание

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

mark_model=MERCEDES%23C_KLASSE&mark_model=HONDA

Стоимость транспорта в выбранной валюте (например, российский рубль), от.

Стоимость транспорта в выбранной валюте (например, российский рубль), до.

Состояние транспортного средства.

Допустимые значения:
  • NEW — новое транспортное средство;
  • USED — транспортное средство с пробегом (б/у).

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, от. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».

Дата создания объявления в формате ISO 8601 со смещением относительно UTC. Например, 2017-07-08T11:29:16+03:00, до. Необходимо закодировать символы: «:» — «%3A», «+» — «%2B».

Фильтр. Показывает объявления без примененных услуг.

Причина блокировки объявления. Подробнее с описанием причин блокировки можно ознакомиться в Справочнике причин блокировки.