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

API
Главная / API - Other methods of address book

Other methods of address book

Обновлено 24.05.2018
65 кб

General information

This service allows you to perform other actions with address book that are not described in other sections.

Deletion of objects from the address book

Method request

Request example

Method address: https://api.dellin.ru/v1/customers/book/delete.json

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragents":{   
      "id":[123, 345]
   },
   "addresses":{   
      "id":[3,2,1]
   },
   "phones":{   
      "id":[1,2]
   },
   "contacts":{   
      "id":[1,2,3]
   }
}

Method address: https://api.dellin.ru/v1/customers/book/delete.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragents>
      <id>123</id>
      <id>345</id>
   </counteragents>
   <addresses>
      <id>3</id>
      <id>2</id>
      <id>1</id>
   </addresses>
   <phones>
      <id>1</id>
      <id>2</id>
   </phones>
   <contacts>
      <id>1</id>
      <id>2</id>
      <id>3</id>
   </contacts>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

sessionID

YesstringTo get the session ID, use the User Authorization method

counteragents

NoobjectInformation about the counterparties that need to be deleted
counteragents.idNo
array of integerArray of ID's of counterparties that need to be deleted
addressesNo
objectInformation about the addresses that need to be deleted
addresses.idNo
array of integerArray of ID's of addresses that need to be deleted
phonesNo
objectInformation about the phone numbers that need to be deleted
phones.idNo
array of integerArray of ID's of phone numbers that need to be deleted
contactsNo
objectInformation about the contact persons that need to be deleted
contacts.idNo
array of integerArray of ID's of contact persons that need to be deleted

Method response

Response example

{  
   "deleted":{  
      "counteragents":[123,345],
      "addresses":[3,2,1],
      "contacts":[1,2,3],
      "phones":[1,2]
   }
}
<response>
   <deleted>
      <counteragents>123</counteragents>
      <counteragents>345</counteragents>
      <addresses>3</addresses>
      <addresses>2</addresses>
      <addresses>1</addresses>
      <contacts>1</contacts>
      <contacts>2</contacts>
      <contacts>3</contacts>
      <phones>1</phones>
      <phones>2</phones>
   </deleted>
</response>

Description of parameters

Response
ParameterTypeDescription
deletedobjectInformation about deleted objects
deleted.counteragentsarray of integerArray of ID's of deleted counterparties
deleted.addressesarray of integerArray of ID's of deleted addresses
deleted.contactsarray of integerArray of ID's of deleted contact persons
deleted.phonesarray of integerArray of ID's of deleted phone numbers