REST API: GET /loans/{id}

Lees eerst de basisinformatie over de REST API.

Uitleenoverzicht van een lener

Het toegangspunt GET /loans/{id} laat je toe om het actuele uitleenoverzicht van een lener op te vragen.

URL parameters

• id: Colibris ID van de lener, of het e-mailadres van de lener

JSON resultaat

• code: HTTP response code (bv. 200 voor een correct resultaat)
• response: data van de ontleende objecten

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/loans/000002",
    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",
    "response": {
        "user": "000001",
        "naam": "De Decker",
        "voornaam": "Julie",
        "loans": [
            {
                "type": "Boek",
                "colibris_barcode": "2100010401",
                "barcode": "9789059564169",
                "titel": "Comfort : Nederlandse editie",
                "auteur": "Ottolenghi, Yotam",
                "jaar": 2024,
                "uitgever": "Fontaine Uitgevers",
                "vestiging": "MEC",
                "lokaal": "BUR",
                "datum_uitleen": "2024-11-19 12:03:14",
                "datum_retour": "2024-12-17"
            }
        ]
    }
}

Wanneer er geen openstaande uitleen is, dan blijft de array “loans” leeg. User, naam en voornaam worden wel geretourneerd ter controle.