REST API: GET /users

Lees eerst de basisinformatie over de REST API.

Volledige lijst met leners

Het toegangspunt GET /users laat je toe om een volledige lijst met leners op te vragen.

URL parameters

• Geen input parameters

JSON resultaat

• code: HTTP response code (bv. 200 voor een correct resultaat)
• totaal: totaal aantal leners in het antwoord
• response: data van alle leners

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/users",
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 15,
    CURLOPT_HTTPHEADER => array(
	'X-Api-User: API_USER',
	'X-Api-Login: API_LOGIN',
	'X-Api-Key: API_KEY',
	'Content-Type: application/json'
    ),
));

$data = curl_exec($curl);
$http_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
    echo "Error #:" . $err;
} else {
    print_r($data);
}
?>

API Voorbeeldantwoord

{
    "code": "200",
    "totaal": 2,
    "response": [
        {
            "id": "000001",
            "naam": "Janssens",
            "voornaam": "Nina",
            "email": "nina@janssens.be",
            "email_melding": "",
            "pass": "",
            "taal": "nl",
            "sp1": "4A",
            "sp2": "0475102030",
            "externe_id": "00001234",
            "groep": "|01|",
            "notitie": "notitie"
        },
        {
            "id": "000002",
            "naam": "Peeters",
            "voornaam": "Lili",
            "email": "lili@peeters.be",
            "email_melding": "",
            "pass": "",
            "taal": "nl",
            "sp1": "2C",
            "sp2": "",
            "externe_id": "00006789",
            "groep": "|",
            "notitie": ""
        }
    ]
}

Het wachtwoord zal steeds leeg zijn.

Meer informatie over de verschillende velden vind je in het artikel over het importeren van leners.