deleteOrganisation

Entfernt eine Organisation aus dem Adressbuch.

Route	/addressbook/deleteOrganisation[/:key[/:hash[/:format]]]
Erforderliche Parameter	hash
Optionale Parameter	format
Rückgabewerte	hash
querschnittsverbindungen	getOrganisations()- Enthält die hashes aller existierenden Organisationen
hinweise	–

Parameter

bezeichnung	beschreibung	wertebereich	default wert
hash	Organisationshash	string	–
format	Definiert von welchem format das Ergebnis sein soll.	json|xml	json

Return Values

bezeichnung	beschreibung	wertebereich
hash	Id of the person.	(a-z0-9){32}

Nachrichten

Nachricht	Beschreibung
no permission	Kein Zugriff auf die Funktion.
internal error	Ein interner Fehler.
param missing	Ein Parameter fehlt.
param invalid	Der Wert eines Parameters ist falsch.
result empty	Die Anfrage war erfolgreich, enthält aber ein leeres Ergebnis.
cost error	Der Kreditrahmen ist ausgeschöpft.
0k.	Alles ok.

Beispielcode

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
    'service' => 'addressbook',
    'method'  => 'deleteOrganisation',
    'key'     => 'myPersonalKey',
    'hash'    => 'hashOfTheOrganisation'
);
$pathString = implode('/', $arrayParams);

$requestURL = $root.$pathString;

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);

// 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>
        <organisations>
            <organisation>
                <hash>3957d580698c3345c9a962e077c44961</hash>
           </organisation>
        </organisations>
    </apiResult>
</result>