REST API v3: GET collection

Een collectie is een "tweede laag" binnen een database. Als je de numerieke identifier van een collectie weet, dan kun je met een HTTP GET request de gegevens van de collectie ophalen:

https://api.copernica.com/v3/collection/$id?access_token=xxxx

Als $id moet je de numerieke identifier van de collectie opgeven.

Geretourneerde velden

De methode retourneert een JSON object dat de volgende velden bevat:

Variabele Omschrijving
ID ID van de collectie.
name Naam van de collectie.
database ID van de database waartoe de collectie behoort.
fields Array met de velden in de collectie.
intentions Array met de intenties voor deze collectie (1 of null voor email/sms/pdf).

JSON voorbeeld

De JSON voor een collectie ziet er bijvoorbeeld zo uit:

{  
   "ID":"25935",
   "name":"Orders",
   "database":"7453",
   "fields":{  
      "start":0,
      "limit":100,
      "count":7,
      "data":[  
         {  
            "ID":"9277",
            "name":"email",
            "type":"email",
            "value":"test@copernica.nl",
            "displayed":true,
            "ordered":false,
            "length":"100",
            "textlines":"0",
            "hidden":false,
            "index":false
         },
         {  
            "ID":"9879",
            "name":"order_number",
            "type":"integer",
            "value":"0",
            "displayed":true,
            "ordered":false,
            "length":"100",
            "textlines":"0",
            "hidden":false,
            "index":false
         }
      ],
      "total":2
   }
}

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 in je access code access token
$api = new CopernicaRestAPI("your-access-token", 3);

// voer de opdracht uit en print het resultaat
print_r($api->get("collection/{$collectieID}"));

Dit voorbeeld vereist de REST API klasse.

Meer informatie