REST API: DELETE /users/{id}

Lees eerst de basisinformatie over de REST API.

Een specifieke lener verwijderen

Het toegangspunt DELETE /users/{id} laat je toe om een specifieke lener te verwijderen uit de databank.

URL parameters

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

JSON resultaat

• code: HTTP response code
  204 voor een correcte verwijdering
  404 voor een niet bestaande lener
  406 voor een lener die niet verwijderd kan worden

Bij het verwijderen van een lener, wordt steeds gekeken of er nog openstaande ontleningen zijn. Als dit het geval is, dan kan de lener niet worden verwijderd.

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/users/000002",
    CURLOPT_CUSTOMREQUEST => "DELETE",
    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": "204"
}