REST API v1: GET database interests

Waarschuwing: Je bekijkt nu het overzicht voor de oude versie van onze API. Wij raden aan om onze laastste versie van de API te gebruiken.

Een overzicht van alle beschikbare interesses in een database kun je opvragen met de volgende URL:

https://api.copernica.com/v1/database/$id/interests?access_token=xxx

De variabele $id moet je vervangen door de numerieke identifier of de naam van de database waar je de interesses van wilt opvragen.

Beschikbare parameters

De volgende parameters kunnen aan de URL als variabelen worden toegevoegd:

  • start: eerste interesse die wordt opgevraagd
  • limit: lengte van de batch die wordt opgevraagd
  • total: toon wel/niet het totaal aantal interesses in de output

Meer informatie over de betekenis van deze parameters vind je in het artikel over paging.

Geretourneerde velden

De methode retourneert een lijst van interesses in de database. Voor elke interesse worden de volgende eigenschappen teruggegeven:

  • ID: numeriek ID van de interesse
  • name: naam van de interesse
  • group: naam van de interessegroep waar de interesse bij hoort

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je de API methode kunt aanroepen:

// vereiste scripts
require_once('copernica_rest_api.php');

// verander naar je acces token
$api = new CopernicaRestApi("your-access-token");

// parameters voor de methode
$parameters = array(
    'limit'     =>  100
);

// voer methode uit en print resultaat
print_r($api->get("database/1234/interests", $parameters));

Dit voorbeeld vereist de REST API class.

Meer informatie