Home > Documentatie > REST API v4: POST profile lock

REST API v4: POST profile lock

Om een profiel te vergrendelen aan een specifieke selectie, kun je een HTTP POST 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 dat je wilt vergrendelen. De identifier van de selectie (view) waaraan het profiel vergrendeld 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 dat vergrendeld moet worden (in de URL).
  • view: De ID van de selectie waaraan het profiel vergrendeld moet worden (in de request body).

Request body

De body van het POST 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 waaraan het profiel vergrendeld moet worden
);

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

// Bij een succesvolle operatie zal de API een X-locked header terugsturen
// en een HTTP 200 OK status.

Dit voorbeeld vereist de REST API klasse.

Meer informatie