Mit einer Account-Sammelliste können Sie ausgewählte Accounts zusammenstellen. Die im Folgenden aufgeführten Webservice-Aufrufe erlauben es, so gebildete Sammellisten abzurufen sowie Accounts zu ihnen hinzufügen oder aus ihnen zu entfernen.
Alle Account-IDs einer Sammelliste ermitteln
curl http://hostname/webservice/account_collections/id \ -u webservice:apikey
Das Ergebnis ist die Liste der Account-IDs, die in derjenigen Sammelliste enthalten sind, die in der URL über ihre ID referenziert wird:
<?xml version="1.0" encoding="UTF-8"?>
<collection>
<title>Top Companies</title>
<id type="integer">id</id>
<account_ids type="array">
<account_id type="integer">3</account_id>
...
</account_ids>
</collection>
Weitere Informationen über Accounts finden Sie in der Dokumentation zu den Feldern von und Webservices für Accounts.
Accounts zu einer Sammelliste hinzufügen
Um Accounts über ihre ID zu einer Account-Sammelliste hinzuzufügen, können Sie den folgenden Webservice verwenden:
curl http://hostname/webservice/account_collections/id/add_account_ids \ -u webservice:apikey \ -X POST \ --form-string account_ids[]=2 \ --form-string account_ids[]=15 \ --form-string account_ids[]=21
Als Antwort wird eine Meldung zurückgegeben:
<?xml version="1.0" encoding="UTF-8"?> <hash> <count type="integer">3</count> <message>Added 3 account(s) to collection.</message> </hash>
Werden als Parameter IDs übergeben, die keine Accounts referenzieren, so werden diese IDs ignoriert.
Accounts aus einer Account-Sammelliste entfernen
curl http://hostname/webservice/account_collections/id/remove_account_ids \ -u webservice:apikey \ -X POST \ --form-string account_ids[]=3 \ --form-string account_ids[]=16 \ --form-string account_ids[]=23
Als Antwort wird eine Meldung zurückgegeben:
<?xml version="1.0" encoding="UTF-8"?> <hash> <count type="integer">1</count> <message>Removed 1 account(s) from collection.</message> </hash>
Werden als Parameter IDs übergeben, die keine Accounts referenzieren, so werden diese IDs ignoriert.