REST API v2: GET database views

Je kunt bekijken welke selecties beschikbaar zijn door een HTTP GET request te sturen naar de volgende URL:

https://api.copernica.com/v2/database/$id/views?access_token=xxxx

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

Beschikbare parameters

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

Variabele Omschrijving
start Eerste selectie die wordt opgevraagd.
limit Lengte van de batch die wordt opgevraagd.
total Toon wel/niet het totaal aantal beschikbare selecties.

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

Geretourneerde velden

De methode retourneert een JSON object met selecties onder het data veld. Elke selectie bevat de volgende velden:

Variabele Omschrijving
id Unieke numerieke identifier van selectie.
name Naam van de selectie.
description Beschrijving van de selectie.
parent-type Type van de parent (view/database).
parent-id ID van de parent.
has-children Boolean die aangeeft of de selectie zelf selecties bevat.
has-referred Boolean die aangeeft of er andere selecties zijn die naar deze selectie refereren.
has-rules Boolean die aangeeft of de selectie regels heeft.
database ID van de database waar deze selectie onder valt.
last-built Tijdstempel van de laatste bouw van de selectie.
intentions Array met de intenties voor deze selectie (1 of null voor email/sms/pdf).

JSON voorbeeld

De JSON voor een enkele selectie ziet er bijvoorbeeld zo uit:

{  
   "ID":"1384",
   "name":"Leadscoring",
   "description":"",
   "parent-type":"database",
   "parent-id":"7616",
   "has-children":false,
   "has-referred":false,
   "has-rules":true,
   "database":"7616",
   "last-built":"2019-04-17 00:21:26"
}

Voorbeeld in PHP

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

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

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 2);

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

// voer de methode uit en print het resultaat
print_r($api->get("database/{$databaseID}/views", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie