REST API v3: PUT collection

Als je de gegevens van een collectie wilt bijwerken, kun je dit doen door een HTTP PUT verzoek naar de volgende URL te sturen:

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

De variabele $id in de URL moet worden vervangen door de numerieke identifier van de collectie die je wilt bewerken.

Beschikbare parameters

De volgende variabele kan in de body van het HTTP PUT commando worden geplaatst:

  • name: de optionele nieuwe naam van de collectie

Voorbeeld in JSON

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

{
  "name": "mijn_collectie",
}

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

// data voor de methode
$data = array(
    'name'  =>  'new-collection-name'
);

// voer het verzoek uit
api->put("collection/{$collectionID}", $data);

Dit voorbeeld vereist de REST API klasse.

Meer informatie