Получение краткой информации о фирме по номеру телефона [1.2]

Описание

Получение краткой информации о другой фирме по номеру телефона. Телефон указывается с кодом страны и города, без пробелов и дополнительных знаков. Метод доступен только для зарегистрированных платных пользователей.

Структура URL

HTTP метод: GET, ресурс: <base_url>/firms/search/summary?phone=<номер телефона>

Результат

Коллекция структур "Краткая информация о фирме", где в поле contact_names содержатся все контакты фирмы, у которых указан запрашиваемый телефонный номер.

Светофор

Для пользователей, оплативших лицензию "Светофор", доступна информация по следующим полям структуры "Краткая информация о фирме": firm_color, account_color, affiliated_firms. 

Для платных пользователей АТИ доступно поле affiliated_firms.

Пример запроса и ответа

Запрос

GET,  http://api.ati.su/v1.2/firms/search/summary?phone=78126020109

Ответ

Ответ в формате JSON

 

[
  {
    "ati_id": "123456",
    "full_name": "Фирма 1, ИП",
    "firm_type": "Экспедитор-перевозчик",
    "info_reference": "http://ati.su/firms/123456/info",
    "passport_reference": "http://ati.su/firms/123456/passport",
    "city": "Санкт-Петербург",
    "score": 5,
    "claims_count" : 0,
    "recommendations_count" : 1,
    "bad_partner_mentions_count": 0,
    "inn": null,
    "ogrn": null,
	"negative_points_sum": 0,
                     "negative_points_sum": 0,
                     "tf_firm_color": "Red",
                     "tf_account_color": "Yellow",
                     "affiliated_firms": [       
                        {
                            "firm_name": "Связанная фирма 1",
                            "inn": "111113333333",
                            "tf_firm_color": "Red",
                            "tf_has_signals": true
                        },
                        {
                            "firm_name": "Связанная фирма 2",
                            "inn": "1111111133333",
                            "tf_firm_color": "Yellow",
                            "tf_has_signals": true
                                        }],
                     "tf_has_signals": true,
                     "registration_date": "2005-06-06T08:45:27.647Z",
                     "contact_info_changed": "2018-02-28T12:51:13.76Z",
                     "last_month_active_days": 25
    "contact_names": [
      "Имя контакта 1",
      "Имя контакта 2"
    ]
  },
  {
    "ati_id": "654321",
    "full_name": "Фирма 2, ИП",
    "firm_type": "Перевозчик",
    "info_reference": "http://ati.su/firms/654321/info",
    "passport_reference": "http://ati.su/firms/654321/passport",
    "city": "Санкт-Петербург",
    "score": 4,
    "claims_count" : 0,
    "recommendations_count" : 1,
                     "negative_points_sum": 0,
                     "tf_firm_color": "Red",
                     "tf_account_color": "Yellow",
                     "affiliated_firms": [       
                        {
                            "firm_name": "Связанная фирма 1",
                            "inn": "111113333333",
                            "tf_firm_color": "Red",
                            "tf_has_signals": true
                        },
                        {
                            "firm_name": "Связанная фирма 2",
                            "inn": "1111111133333",
                            "tf_firm_color": "Yellow",
                            "tf_has_signals": true
                                        }],
                     "tf_has_signals": true,
                     "registration_date": "2005-06-06T08:45:27.647Z",
                     "contact_info_changed": "2018-02-28T12:51:13.76Z",
                     "last_month_active_days": 25
    "bad_partner_mentions_count": 0,
    "inn": null,
    "ogrn": null,
	"negative_points_sum": 0,
    "contact_names": [
      "Имя контакта 1"
    ]
  },
]

Список ответов сервера

HTTP код ответа
Код ошибки
Сообщение
200--Операция завершена успешно
204--Не найдено ни одного контакта, у которого указан запрашиваемый номер телефона 
400invalid_input_dataОшибка валидации
401--Требуется авторизация
402payment_requiredТребуется оплатить доступ в АТИ
403forbiddenПревышен лимит запросов запросов на получение краткой информации фирмы по номеру телефона