Home > Documentatie > REST API v4: GET profile locks

REST API v4: GET profile locks

Deze methode kan gebruikt worden om op te vragen aan welke selecties een profiel is vergrendeld.

Hou in gedachten dat $id zoals altijd vervangen moet worden met de numerieke identifier van het profiel waarvan je de locks opvraagt.

Lijst van selectie locks

Een lijst van selecties waaraan een profiel vergrendeld is kan worden opgevraagd door een HTTP GET request te sturen naar de volgende URL:

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

Deze call geeft een lijst van JSON objecten terug. Elk object in de array representeert een selectie waaraan het profiel vergrendeld is en heeft de volgende eigenschappen:

Variabele Omschrijving
id Unieke numerieke identifier van selectie.
name Naam van de selectie.
description Beschrijving van de selectie.
parent-type Type van de parent (view/database).
parent-id ID van de parent.
has-children Boolean die aangeeft of de selectie zelf selecties bevat.
has-referred Boolean die aangeeft of er andere selecties zijn die naar deze selectie refereren.
has-rules Boolean die aangeeft of de selectie regels heeft.
database ID van de database waar deze selectie onder valt.
last-built Tijdstempel van de laatste bouw van de selectie.
intentions Array met de intenties voor deze selectie (1 of null voor email/sms/pdf).
archived Boolean die aangeeft of de selectie gearchiveerd is.

JSON voorbeeld

De JSON voor een selectie ziet er bijvoorbeeld zo uit:

{  
   "ID":"1384",
   "name":"Leadscoring",
   "description":"",
   "parent-type":"database",
   "parent-id":"7616",
   "has-children":false,
   "has-referred":false,
   "has-rules":true,
   "database":"7616",
   "last-built":"2019-04-17 00:21:26",
   "intentions":{"email": false,"sms": false,"fax": false,"pdf": false},
   "archived": false
}

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je de API methode gebruikt:

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

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

// voer het verzoek uit en print het resultaat
print_r($api->get("profile/{$profielID}/locks"));

Dit voorbeeld vereist de REST API klasse.

Meer informatie