getSubaccounts

Gibt angelegte Subaccounts eines Hauptaccounts zurück.

Route /user/getSubaccounts[/:key[/:format]]
Erforderliche Parameter
Optionale Parameter format
Rückgabewerte hash
name
email
Querschnittverbindungen
Hinweise

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
hash Id des Subaccounts (a-z0-9){32}
name Name des Subaccounts (a-z0-9){32}
email Email-Adresse des Subaccounts. (a-z0-9){32}

Meldungen

Nachricht Beschreibung
no permission Der Schlüssel hat keinen Zugriff auf diese Funktion.
internal error Ein interner Fehler ist aufgetreten.
param missing Ein erforderlicher Parameter wurde nicht übergeben.
param invalid Der Wert eines übergebenen Parameters ist nicht gültig.
result empty Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer.
cost error Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten.
0k. Die Bearbeitung der Anfrage war erfolgreich.

Beispielcode

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
                     'service' =>'user',
                     'method'  =>'getSubaccounts',
                     'key'     =>'myPersonalKey',
		  );
$GETparams = implode('/', $arrayParams);

$requestURL = $root.$GETparams;

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",
        "name": "mySubuser",
	"email": "mySubuser@xovi.de",
    }]
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<result>
 <apiErrorCode>0</apiErrorCode>
 <apiErrorMessage>0k.</apiErrorMessage>
 <apiResult>
     <subusers>
         <subuser>
         <hash>3957d580698c3345c9a962e077c44961</hash>
         <name>mySubuser</name>
         <email>mySubuser@xovi.de</email>
        </subuser>
     </subusers>
 </apiResult>
</result>