REST API v4: POST collection miniviews

Om een nieuwe selectie aan te maken, moet je een HTTP POST-request sturen naar de volgende URL. De selectie wordt dan direct onder de collectie aangemaakt.

https://api.copernica.com/v4/collection/$id/miniviews

De code $id moet je vervangen door de numerieke identifier of de naam van de collectie waar je een selectie aan wilt toevoegen. De naam van de selectie moet als message body aan het HTTP-request worden toegevoegd.

Beschikbare parameters

De volgende variabele moet in de body van de HTTP POST call worden geplaatst.

  • name: Naam van de nieuw aan te maken selectie (verplicht)
  • description: Beschrijving van de nieuw aan te maken collectie

Voorbeeld in JSON

De volgende JSON demonstreert hoe je de API methode kunt gebruiken:

{
  "name": "mijn_miniselectie",
  "description": "Dit is een miniselectie"
}

Voorbeeld in PHP

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

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

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

// data voor de methode
$data = array(
    'name'          =>  'mijn-selectie', 
    'description'   =>  'Dit is een selectie'
);

// voer het verzoek uit
$api->post("collection/{$collectieID}/miniviews", $data);

// bij een succesvolle call wordt het id van het aangemaakte verzoek teruggegeven

Dit voorbeeld vereist de REST API-klasse.

Meer informatie