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

API
Главная / API - Удаление объектов из адресной книги

Удаление объектов из адресной книги

Обновлено 23.04.2020
80 кб

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

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

Удаление объектов из адресной книги

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

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

Адрес метода: https://api.dellin.ru/v2/book/delete.json

{   
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentIDs":[
      123,
      345
   ],
   "addressIDs":[
      3,
      2,
      1
   ],
   "phoneIDs":[
      1,
      2
   ],
   "contactIDs":[
      1,
      2,
      3
   ]
}

Адрес метода: https://api.dellin.ru/v2/book/delete.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <counteragentIDs>123</counteragentIDs>
   <counteragentIDs>345</counteragentIDs>
   <addressIDs>3</addressIDs>
   <addressIDs>2</addressIDs>
   <addressIDs>1</addressIDs>
   <phoneIDs>1</phoneIDs>
   <phoneIDs>2</phoneIDs>
   <contactIDs>1</contactIDs>
   <contactIDs>2</contactIDs>
   <contactIDs>3</contactIDs>
</request>

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

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

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
counteragentIDsНетarray of integerМассив ID контрагентов, которых нужно удалить
addressIDsНетarray of integerМассив ID адресов, которые нужно удалить
phoneIDsНетarray of integerМассив ID контактных телефонов, которые нужно удалить
contactIDsНетarray of integerМассив ID контактных лиц, которых нужно удалить

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "deleted":{
         "counteragentIDs":[
            123
         ],
         "addressIDs":[
            3,
            2,
            1
         ],
         "contactIDs":[
            1,
            2,
            3
         ],
         "phoneIDs":[
            1,
            2
         ]
      },
      "notDeleted":{
         "counteragentIDs":[
            123
         ],
         "addressIDs":[
            6,
            5,
            4
         ],
         "contactIDs":[
            4,
            5,
            6
         ],
         "phoneIDs":[
            3,
            4
         ]
      }
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <deleted>
         <counteragentIDs>123</counteragentIDs>
         <addressIDs>3</addressIDs>
         <addressIDs>2</addressIDs>
         <addressIDs>1</addressIDs>
         <contactIDs>1</contactIDs>
         <contactIDs>2</contactIDs>
         <contactIDs>3</contactIDs>
         <phoneIDs>1</phoneIDs>
         <phoneIDs>2</phoneIDs>
      </deleted>
      <notDeleted>
         <counteragentIDs>123</counteragentIDs>
         <addressIDs>6</addressIDs>
         <addressIDs>5</addressIDs>
         <addressIDs>4</addressIDs>
         <contactIDs>4</contactIDs>
         <contactIDs>5</contactIDs>
         <contactIDs>6</contactIDs>
         <phoneIDs>3</phoneIDs>
         <phoneIDs>4</phoneIDs>
      </notDeleted>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusstringЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация об удаляемых объектах
data.deletedDeletedПеречень объектов, удаленных из адресной книги
data.notDeletedDeletedПеречень объектов, не удаленных из адресной книги (из-за того что объект с таким ID отсутствует)

Deleted
Deleted
ПараметрТипОписание
counteragentIDsarray of integerМассив ID контрагентов
addressIDsarray of integerМассив ID адресов
contactIDsarray of integerМассив ID контактных лиц
phoneIDsarray of integerМассив ID контактных телефонов

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".