REST API v3: bijwerken van een loopblok (Publisher)
Methode om een loopblok bij te werken. Dit is een HTTP PUT-methode die toegankelijk is via het volgende adres:
https://api.copernica.com/v3/publisher/document/$id/loopblock/$id?access_token=xxxx
De eerste variabele $id
in de URL moet worden vervangen door de numerieke identifier
van het document dat je wilt bewerken. De tweede variabele $id
moet vervangen worden door de numerieke identifier van het loopblok dat je wilt bewerken.
Beschikbare parameters
De volgende variabelen kunnen in de body van het HTTP PUT-commando worden geplaatst:
- condition: conditie van het loopblok
- iterations: aantal iteraties van het loopblok
Voorbeeld in JSON
De volgende JSON demonstreert hoe je de API methode kunt gebruiken:
{
"iterations": 5
}
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", 3);
// data voor de methode
$data = array(
'iterations' => '5'
);
// voer verzoek uit
api->put("publisher/document/{$documentID}/loopblock/{$loopblokID}", $data);
Dit voorbeeld vereist de REST API-klasse.