deletePerson
Entfernt einen Kontakt aus dem Adressbuch.
Route |
/addressbook/deletePerson[/:key[/:hash[/:format]]] |
erforderliche parameter |
hash |
Optionale Parameter |
format |
rückgabewerte |
hash |
querverweise |
getPersons() |
hinweise |
– |
Parameter
bezeichnung |
beschreibung |
wertebereich |
defaultwerte |
hash |
hash of a person. |
array of Projecthashes |
– |
format |
Defines of what format the result is. |
json|xml |
json |
Return Values
bezeichnung |
beschreibung |
wertebereich |
hash |
Id of the person. |
(a-z0-9){32} |
Messages
Nachricht |
Beschreibung |
no permission |
Kein Zugriff auf diese Funktion. |
internal error |
Ein interner Fehler ist passiert. |
param missing |
Ein erforderlicher Parameter fehlt. |
param invalid |
Ein Wert eines Parameters ist falsch. |
result empty |
Die Anfrage endet erfolgreich, aber ohne Ergebnis. |
cost error |
Ihr Kreditrahmen ist ausgeschöpft. |
0k. |
Alles ok. |
Beispielcode
$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'addressbook',
'method' =>'deletePerson',
'key' =>'myPersonalKey',
);
$pathString = implode('/', $arrayParams);
$requestURL = $root.$pathString;
$paramsString = http_build_query($arrayParams);
if (!function_exists('curl_init')) die('cURL not available');
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
//setup POST
curl_setopt($ch, CURLOPT_POST, count($arrayParams));
curl_setopt($ch, CURLOPT_POSTFIELDS, $paramsString);
// Download the given URL, and return output
$output = curl_exec($ch);
// Close the cURL resource, and free system resources
curl_close($ch);
echo $output;
?>
Beispielergebnisse
JSON
{
"apiErrorCode": 0,
"apiErrorMessage": "0k.",
"apiResult": [{
"hash": "b4b292d0c16f20eee10a7754539a189c"
}]
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<persons>
<person>
<hash>3957d580698c3345c9a962e077c44961</hash>
</person>
</persons>
</apiResult>
</result>