Foutmeldingen

  • Aangemaakt : 01-03-2023
  • Laatste update: 01-12-2023

Foutmeldingen worden via een errors object weergegeven. Dit object bevat een array met alle foutmeldingen. Dat ziet er als volgt uit:

Variabele Type Omschrijving
Object: errors[]
error String Unieke errorcode in formaat AA-AA00
parameter String De parameter waar de foutmelding betrekking op heeft
message String De foutmelding
details String Uitgebreide beschrijving van de foutmelding

Voorbeeld

Het verwijderen van een niet bestaand contact levert de volgende foutmelding op.

{
  "errors": [
    {
      "error": "CT-HL01",
      "parameter": "handle",
      "message": "Contact handle not found",
      "details":  "The specified contact handle was not found"
    }
  ]
}
    

Fouten uitlezen in PHP:
<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/contacts/ABCD-0001";
$api_host = $env == "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key","Accept: application/json"));
$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if($http_code === 200) {
  echo "OK contact deleted";
}
elseif($http_code === 400) {
  echo "Something went wrong:<br>";
  
  $obj_json = json_decode($response);
  
  foreach($obj_json->errors as $obj_error) {
    echo "Error: ";
    echo $obj_error->error;
    echo "<br>Parameter: ";
    echo $obj_error->parameter;
    echo "<br>Message: ";
    echo $obj_error->message;
    echo "<br>Details: ";
    echo $obj_error->details;
  }
}