REST API v3: GET profile subprofiles

Subprofielen zijn voor collecties wat reguliere profielen zijn in een database. Om een lijst van subprofielen van een profiel uit een collectie op te vragen kun je een HTTP GET verzoek sturen naar de volgende URL:

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

De eerste $id moet vervangen worden met de ID van het profiel waar je de subprofielen van opvraagt en de tweeede $id moet vervangen worden met de ID van de collectie.

Teruggegeven velden

De methode retourneert een JSON object met de subprofielen onder het data veld. Elk subprofiel bevat de volgende velden:

  • ID: ID van het subprofiel.
  • secret: De "geheime" code die aan een subprofiel is gekoppeld.
  • fields: Associative array / object van veldnamen en veldwaardes.
  • profile: ID van het profiel waar het subprofiel onder hoort.
  • collection: ID van de collectie waarin het subprofiel is opgeslagen.
  • created: Tijdstip waarop het subprofiel in aangemaakt, in YYYY-MM-DD hh:mm:ss formaat.
  • modified: Tijdstip waarop het subprofiel voor het laatst is bijgewerkt, in YYYY-MM-DD hh:mm:ss formaat.
  • removed: Geeft aan of het subprofiel verwijderd is ('true') of niet ('false').

JSON voorbeeld

De JSON voor een enkel subprofiel ziet er bijvoorbeeld zo uit:

{  
   "ID":"20285",
   "secret":"132879300b4731870080b1cd301fd43d",
   "fields":{  
   },
   "profile":"2139358",
   "collection":"6312",
   "created":"2008-08-25 16:14:56",
   "modified":"2010-08-25 16:15:56",
   "removed":false
}

Voorbeeld

Het volgende PHP script demonstreert hoe de API method te gebruiken is.

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

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

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

Dit voorbeeld vereist de REST API klasse.

Meer informatie