Список заявок брокера¶

Параметры¶

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	broker_application	`https://api.admitad.com/website/{w_id}/broker/applications/`	Список параметров для запроса.	Возвращает список созданных заявок, гдe w_id - идентификатор площадки.*

* Возвращает результат в формате JSON.

Список параметров для запроса.¶

Название	Тип	Ограничения
offset	integer	Параметры limit, offset
limit	integer	Параметры limit, offset
order_by	string	date_created Знак ‘-‘ перед значением означает обратный порядок. Например order_by=-date_created
id	integer
campaign	integer	Список партнёрских программ
status	string	processing approved declined waiting error
date_start	date	%d.%m.%Y
date_end	date	%d.%m.%Y
order_id	string
occupation	string
inn	string
product_type	string
subid	string
subid1	string
subid2	string
subid3	string
subid4	string

Пример использования¶

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET 'https://api.admitad.com/website/{w_id}/broker/applications/?offset=0&limit=1'

Пример ответа API-сервера в формате JSON:

{
    "results": [
        {
            "id": 1,
            "first_name": "first_name",
            "last_name": "last_name",
            "middle_name": "middle_name",
            "birth_date": null,
            "birth_place": "",
            "gender": "",
            "mobile_phone": "03512345678",
            "phone": "",
            "occupation": "",
            "work_date": "2016-11-11",
            "work_salary": null,
            "work_organization": "",
            "work_address": "",
            "work_phone": "",
            "work_occupation": "",
            "email": "test@gmail.com",
            "inn": "",
            "passport_cn": "",
            "passport_date": null,
            "passport_title": "",
            "fact_region_name": "",
            "fact_city_name": "",
            "fact_street": "",
            "fact_house": "",
            "fact_housing": "",
            "fact_flat": "",
            "reg_region_name": "",
            "reg_city_name": "",
            "reg_street": "",
            "reg_house": "",
            "reg_housing": "",
            "reg_flat": "",
            "overdue_loans": "",
            "credit_sum": null,
            "credit_days": null,
            "product_type": "",
            "subid": "",
            "subid1": "",
            "subid3": "",
            "subid2": "",
            "subid4": "",
            "responses": [
                {
                    "campaign_id": 1
                    "status": "processing",
                    "order_id": null
                }
            ]
        }
    ],
    "_meta": {
        "count": 1,
        "limit": 1,
        "offset": 0
    }
}

Описание полей ответа API-сервера¶

Название	Описание
id	Идентификатор заявки
responses	Информация об отправке заявки в кампании
errors	Ошибки при создании заявки
Остальные Параметры заявки

Описание полей в информации об отправке заявки в кампании¶

Название	Описание
campaign_id	Идентификатор кампании
status	Статус отправки: processing (в очереди на отправку в кампанию) approved (одобрена кампанией) declined (отклонена кампанией) waiting (обрабатывается кампанией) error (ошибки на стороне кампании)
order_id	ID заказа в системе

Описание полей ошибок при создании заявки¶

Название	Описание
campaign_id	Идентификатор кампании
message	Сообщение об ошибке