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

API
Главная / API - Контактные данные

Контактные данные

Обновлено 09.08.2017
117 кб

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

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

Получение списка контактных лиц и телефонов

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

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

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

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":"1"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <addressid>533046</addressid>
</request>

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

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

ДаstringID  адреса, по которому нужно получить информацию о контактных лицах и телефонах

Ответ метода

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

[  
   {  
      "contacts":[  
         {  
            "id":"1",
            "contact":"Иван Иванович Иванов"
         },
         {  
            "id":"3",
            "contact":"Петр"
         }
      ],
      "lastUpdate": "2017-05-18T17:23:58.000+03:00",
      "phones": [
         {
            "id":"123",
            "phone":"79002350122", 
            "phoneFormatted":"+7 (900) 235-01-22", 
            "addNumber":"55677"
         },
         { 
            "id":"321",
            "phone":"375127789955", 
            "phoneFormatted":"+375 (12) 778-99-55"
         },
         { 
            "id":"456", 
            "phone":"495778999999999999", 
            "addNumber":"0890"
         }
      ]
   }
]
<response>
   <contacts>
      <id>1</id>
      <contact>Иван Иванович Иванов</contact>
   </contacts>
   <contacts>
      <id>3</id>
      <contact>Петр</contact>
   </contacts>
   <lastUpdate>2017-05-18T17:23:58.000+03:00</lastUpdate>
   <phones>
      <id>123</id>
      <phone>79002350122</phone>
      <phoneFormatted>+7 (900) 235-01-22</phoneFormatted>
      <addNumber>55677</addNumber>
   </phones>
   <phones>
      <id>321</id>
      <phone>375127789955</phone>
      <phoneFormatted>+375 (12) 778-99-55</phoneFormatted>
   </phones>
   <phones>
      <id>456</id>
      <phone>495778999999999999</phone>
      <addNumber>0890</addNumber>
   </phones>
</response>

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

Response
ПараметрТипОписание
contactsarray of Response.ContactsМассив контактных лиц
phonesarray of Response.Phones

Массив контактных телефонов

lastUpdatestringДата последнего обновления данных

Response.Contacts
ПараметрТипОписание
idstringID контактного лица
contactstring

ФИО контактного лица

Response.Phones
ПараметрТипОписание
idstringID контактного телефона
phonestring

Контактный телефон без форматирования

phoneFormattedstringКонтактный телефон с форматированием. Отсутствует, если невозможно форматирование по международному стандарту
addNumberstringДобавочный номер

Создание и редактирование контактных лиц

Создание контактного лица

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":"4",
   "contact":"Иван"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <addressid>4</addressid>
   <contact>Иван</contact>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

ДаstringID адреса, для которого нужно добавить контактное лицо
contactДаstringФИО контактного лица

Ответ метода

Пример ответа
{  
   "success":{  
      "addressID":"4",
      "personID":"244"
   }
}
<response>
   <success>
      <addressid>4</addressid>
      <personid>244</personid>
   </success>
</response>
Описание параметров
Response
ПараметрТипОписание
successobjectИнформация о добавленном контактном лице
success.addressIDstringID адреса, для которого было добавлено контактное лицо
success.personIDstringID контактного лица

Обработка ошибок

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

Пример ответа
{  
   "errors":{  
      "contact":"не передано обязательное поле"
   }
}
<response>
   <errors>
      <contact>не передано обязательное поле</contact>
   </errors>
</response>

Редактирование контактного лица

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "personID":"244",
   "contact":"Иван Иванович"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <personid>244</personid>
   <contact>Иван Иванович</contact>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

personID

ДаstringID контактного лица, которое необходимо изменить
contactДаstringФИО контактного лица
Ответ сервиса при редактировании контактного лица аналогичен ответу при создании контактного лица.

Создание и редактирование телефонов

Создание телефона

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":"4",
   "phoneNumber":"+7 (900) 235-01-22",
   "addNumber":"0867"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <addressid>4</addressid>
   <phonenumber>+7 (900) 235-01-22</phonenumber>
   <addnumber>0867</addnumber>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

ДаstringID адреса, для которого нужно добавить контактный телефон
phoneNumberДаstring

Контактный телефон.

addNumberНетstringДобавочный номер. Ограничение на длину значения параметра - 5 символов

Ответ метода

Пример ответа
{  
   "success":{  
      "addressID":"4",
      "phoneID":"214"
   }
}
<response>
   <success>
      <addressid>4</addressid>
      <phoneid>214</phoneid>
   </success>
</response>
Описание параметров
Response
ПараметрТипОписание
successobjectИнформация о добавленном контактном телефоне
success.addressIDstringID адреса, для которого был добавлен контактный телефон
success.phoneIDstringID контактного телефона

Обработка ошибок

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

Пример ответа
{  
   "errors":{  
      "phoneNumber":"не передано обязательное поле"
   }
}
<response>
   <errors>
      <phoneNumber>не передано обязательное поле</phoneNumber>
   </errors>
</response>

Редактирование телефона

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "phoneID":"214",
   "phoneNumber":"+7 (900) 235-01-22",
   "addNumber":"0867"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <phoneid>214</phoneid>
   <phonenumber>+7 (900) 235-01-22</phonenumber>
   <addnumber>0867</addnumber>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

phoneID

ДаstringID контактного телефона, который необходимо изменить
phoneNumberДаstring

Контактный телефон.

addNumberНетstringДобавочный номер. Ограничение на длину значения параметра - 5 символов
Ответ сервиса при редактировании контактного телефона аналогичен ответу при создании контактного телефона.