GET /dealer/campaigns

Возвращает подключенные тарифы дилера.

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

GET https://apiauto.ru/1.0/dealer/campaigns

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

Заголовок

Описание

x-dealer-id

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

x-session-id

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

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

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

{
  "campaigns": [
    {
      "category": "{string}",
      "truck_subcategories": {
        "categories": [
          "{string}"
        ]
      },
      "moto_subcategories": {
        "categories": [
          "{string}"
        ]
      },
      "section": [
        "{string}"
      ],
      "size": {integer}
    }
  ]
}

campaigns

Массив объектов. Информация о тарифах дилера.

category

Категория, для которой действует тариф.

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

truck_subcategories

Информация по категориям коммерческого транспорта.

categories

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

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

moto_subcategories

Информация по категориям мототранспорта.

categories

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

  • ATV — мотовездеход;
  • MOTORCYCLE — мотоцикл;
  • SCOOTERS — скутер;
  • SNOWMOBILE — снегоход.

section

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

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

size

Количество объявлений, доступных по текущему тарифу.

Коды ответа

Код

Причина

Описание

200

OK

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

400

BAD_REQUEST

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

401

NO_AUTH

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

404

CLIENT_NOT_FOUND

Клиент не найден.

500

INTERNAL SERVER ERROR

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

Пример

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/dealer/campaigns' -H 'x-authorization: 2dtrer432...' -H 'Accept: application/json' -H 'x-session-id: 112_aoR02Tpv...'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 02 Aug 2018 10:19:41 GMT
Content-Type: application/json
Connection: keep-alive

{
  "campaigns": [
    {
      "category": "TRUCKS",
      "truck_subcategories": {
        "categories": [
          "BUS",
          "AUTOLOADER",
          "LCV",
          "TRAILER",
          "BULLDOZERS",
          "AGRICULTURAL",
          "CRANE_HYDRAULICS",
          "SWAP_BODY",
          "DREDGE",
          "MUNICIPAL",
          "ARTIC",
          "CRANE",
          "TRUCK",
          "CONSTRUCTION"
        ]
      },
      "section": [
        "USED",
        "NEW"
      ],
      "size": 2147483647
    },
    {
      "category": "CARS",
      "section": [
        "USED"
      ],
      "size": 2147483647
    },
    {
      "category": "MOTO",
      "moto_subcategories": {
        "categories": [
          "MOTORCYCLE",
          "ATV",
          "SCOOTERS",
          "SNOWMOBILE"
        ]
      },
      "section": [
        "NEW",
        "USED"
      ],
      "size": 50
    },
    {
      "category": "CARS",
      "section": [
        "NEW"
      ],
      "size": 2147483647
    }
  ]
}
Предыдущая
GET /dealer/account
Следующая
GET /dealer/offers-daily-stats