Поиск по сайту

API
Главная / API - Список контрагентов

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

Обновлено 08.08.2017
70 кб

Общие сведения

Сервис позволяет получить список контрагентов с типом запроса и доступа.

Получение списка контрагентов

Одна учетная запись Личного кабинета может иметь доступ к нескольким контрагентам, то есть иметь право от имени разных контрагентов оформлять заказы, получать информацию о взаиморасчетах и т.д. 

Этот метод позволяет:

  • получить основную информацию о контрагентах, доступных для одной учетной записи в Личном кабинете;
  • получить полную информацию о контрагентах, доступных для одной учетной записи в ЛК;
  • получить информацию об отклоненных контрагентах;
  • сменить текущего контрагента для осуществления разных операций в ЛК. 

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/customers/counteragents.json 

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cauid": "00000000-0000-0000-0000-000000000001",
   "full_info": true
}

Адрес метода: https://api.dellin.ru/v1/customers/counteragents.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cauid>00000000-0000-0000-0000-000000000001</cauid>
   <full_info>true</full_info>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
cauidНетstringUID контрагента, от имени которого должны создаваться заявки в рамках текущей сессии. Параметр позволяет изменить контрагента, выбранного по умолчанию, на другого контрагента
full_infoНетbooleanПолучение полных данных по всем доступным контрагентам и списка отклоненных контрагентов

Ответ метода

Пример ответа 

{  
   "counteragents":[  
      {  
         "info":{  
            "shared_to":[  
               {  
                  "phone":"+7 (111) 111-11-11",
                  "name":"ФИО",
                  "email":"Pushkino_auto@dellin.ru"
               },
               {  
                  "phone":"+7 (444) 444-44-44",
                  "name":"ФИО",
                  "email":"Petr.Petrov@dellin.ru"
               }
            ],
            "access_level":2,
            "request_comment":null,
            "manager_email":"Ivan.Ivanov@dellin.ru",
            "manager_phone":"+7 (911) 232-95-50",
            "shared_from":{  
               "phone":"+7 (111) 111-11-11",
               "name":"ФИО",
               "email":"ssidorov@dellin.ru"
            },
            "manager_name":"Иванов Иван Иванович"
         },
         "is_current":true,
         "uid":"00000000-0000-0000-0000-000000000000",
         "name":"ООО \"Компания\""
      }
   ]
}
<response>
   <counteragents>
      <info>
         <shared_to>
            <phone>+7 (111) 111-11-11</phone>
            <name>ФИО</name>
            <email>Pushkino_auto@dellin.ru</email>
         </shared_to>
         <shared_to>
            <phone>+7 (444) 444-44-44</phone>
            <name>ФИО</name>
            <email>Petr.Petrov@dellin.ru</email>
         </shared_to>
         <access_level>2</access_level>
         <request_comment />
         <manager_email>Ivan.Ivanov@dellin.ru</manager_email>
         <manager_phone>+7 (911) 232-95-50</manager_phone>
         <shared_from>
             <phone>+7 (111) 111-11-11</phone>
             <name>ФИО</name>
             <email>nbeeva@dellin.ru</email>
         </shared_from>
         <manager_name>Иванов Иван Иванович</manager_name>
      </info>
      <is_current>true</is_current>
      <uid>00000000-0000-0000-0000-000000000000</uid>
      <name>ООО "Компания"</name>
   </counteragents>
</response>


Описание параметров

Response
ПараметрТипОписание
counteragentsarray of Response.CounteragentsДоступные контрагенты

Response.Counteragents
ПараметрТипОписание
infoResponse.Counteragents.InfoПолная информация о контрагентах
is_currentbooleanКонтрагент является/не является текущим выбранным контрагентом в учетной записи. Если в запросе был передан параметр "cauid" с uid контрагента, тогда в ответе у выбранного контрагента значение параметра "is_current" будет равно "true"
uidstringУникальный идентификатор контрагента
namestringНаименование контрагента

Response.Counteragents.Info
ПараметрТипОписание
shared_toarray of Response.Counteragents.Info.SharedToДанные пользователя, которому предоставлен доступ к учетной записи ЛК
access_levelinteger

Уровень предоставленного доступа:

  • 0 = запрос доступа
  • 1 = запрос отклонен
  • 2 = полный доступ
  • 3 = частичный доступ
request_commentstringКомментарий при отклонении доступа
manager_emailstringЭлектронная почта менеджера клиента
manager_phonestringКонтактный телефон менеджера клиента
shared_fromobjectДанные пользователя, который предоставил доступ к учетной записи ЛК
shared_from.phonestringКонтактный телефон пользователя, который предоставил доступ к учетной записи ЛК
shared_from.namestringФИО пользователя
shared_from.emailstringЭлектронная почта пользователя
manager_namestringФИО менеджера клиента

Response.Counteragents.Info.SharedTo
ПараметрТипОписание
phonestringКонтактный телефон пользователя, которому предоставлен доступ к учетной записи ЛК
namestringФИО пользователя
emailstringЭлектронная почта пользователя