Home > Documentatie > REST API v4: DELETE profile lock

REST API v4: DELETE profile lock

Om een profiel te ontgrendelen van een specifieke selectie, kun je een HTTP DELETE request sturen naar de volgende URL:

https://api.copernica.com/v4/profile/$id/lock

De $id in de URL moet vervangen worden door de numerieke identifier van het profiel waarvan je een lock wilt verwijderen. De identifier van de selectie (view) waarvan het profiel ontgrendeld moet worden, dient in de body van het request te worden meegegeven.

Benodigde parameters

Deze methode vereist de volgende parameters:

  • $id: De ID van het profiel waarvan een lock verwijderd moet worden (in de URL).
  • view: De ID van de selectie waarvan het profiel ontgrendeld moet worden (in de request body).

Request body

De body van het DELETE request moet de view parameter bevatten met de ID van de selectie.

{
  "view": 12345
}

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je deze API methode kunt gebruiken:

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

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

// data voor het request, inclusief de ID van de selectie
$data = array(
    'view' => $viewID // ID van de selectie waarvan het profiel ontgrendeld moet worden
);

// voer het verzoek uit
// $profileID is de ID van het profiel
$api->delete("profile/{$profileID}/lock", $data);

// Bij een succesvolle operatie zal de API een X-Unlocked header terugsturen
// en een HTTP 204 No Content of 200 OK status.

Dit voorbeeld vereist de REST API klasse.

Meer informatie