REST API v2: GET miniview subprofiles

Subprofielen zijn voor collecties wat reguliere profielen zijn in een database. De methode om subprofielen uit een miniselectie op te vragen is een HTTP GET methode beschikbaar op het volgende adres:

https://api.copernica.com/v2/miniview/$id/subprofiles?access_token=xxxx

De $id moet vervangen worden met de ID van de miniselectie.

Beschikbare parameters

De volgende parameters kunnen aan de URL als variabelen worden toegevoegd:

  • start: Eerste ID om op te vragen
  • limit: Aantal subprofielen om op te vragen
  • total: Boolean. Geeft aan of het totale aantal subprofielen getoond moet worden. De methode is sneller wanneer dit op 'false' staat.
  • fields: Optionele parameter om condities voor subprofielen mee in te stellen.
  • dataonly: Boolean. Wanneer deze de waarde 'true' heeft worden alleen de ID, velden, collectie ID, profiel ID en datum van laatste aanpassing opgevraagd om de methode sneller te maken.

Paging

Meer over de start, limit en total parameters vind je in het artikel over paging.

Fields

De fields parameter kun je gebruiken om subprofielen te selecteren. Als je bijvoorbeeld alleen subprofielen wil opvragen waarbij de waarde van het veld "land" gelijk is aan "Nederland", kun je dat opgeven in deze parameter. Meer informatie over het gebruik van de fields parameter kun je vinden in een artikel over de fields parameter.

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: Associatieve 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').

Sommige van deze velden worden niet teruggegeven als de dataonly parameter op 'false' staat.

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 in PHP

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", 2);

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

Dit voorbeeld vereist de REST API klasse.

Meer informatie