getPersons

Gibt angelegte Kontakte zurück.

Route	/addressbook/getPersons[/:key[/:format[/:limit[/:skip[/:projhash]]]]]
Erforderliche Parameter	–
Optionale Parameter	format limit (max:1000) skip projhash
Rückgabewerte	hash assignedOrganisationHash labels projects honorific firstname lastname function birthday costumerNumber description email email2 phoneWork phonePrivate phoneMobile fax facebook twitter xing linkedin
Querschnittverbindungen	getProjects() – Diese Funktion enthält die Projekt Hashes.
Hinweise	Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip. resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
projhash	Enthält ein Hash eines angelegten Projektes	md5-String siehe getProjects()	–
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000)	0-1000	100
skip	Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit.	(0-9)+	0
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
hash	Id des Kontaktes	(a-z0-9){32}
assignedOrganisationHash	Id der zugehörigen Organisation	(a-z0-9){32}
labels	Alle dem Kontakt zugeordneten Labels	array
projects	Alle dem Kontakt zugeordneten Projekte	array
honorific	Anrede	string
firstname	Vorname	string
lastname	Nachname	string
function	Funktion	string
birthday	Geburtstag	YYYY-MM-DD
costumerNumber	Kundennummer	string
description	Beschreibung	string
email	E-Mail	string
email2	E-Mail	string
phoneWork	Telefonnummer – Arbeit	string
phonePrivate	Telefonnummer – Privat	string
phoneMobile	Telefonnummer – Mobil	string
fax	Fax	string
facebook	Facebook URL	string
twitter	Twitter URL	string
xing	Xing URL	string
linkedin	Linkedin URL	string

Meldungen

Nachricht	Beschreibung
maximum limit exeeded	Das maximale Limit wurde überschritten.
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' => 'addressbook',
    'method'  => 'getPersons',
    '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",
        "assignedOrganisationHash": "02ed57dc391c5a58808b9087a466ef78",
        "labels": {
            "label_0": "kbdnkaaa",
            "label_1": "lbdnkaaa"
        },
        "projects": {
            "project_0": {
                "hash": "662dfc3980899852736864b4e43cd374",
                "name": "projekt 1"
            },
            "project_1": {
                "hash": "823a1252a8ad6f7c50fd38685de76af2",
                "name": "projekt 2"
            }
        },
        "honorific": "Herr",
        "firstname": "Vorname",
        "lastname": "Nachname",
        "function": "Verkäufer",
        "birthday": "2000-01-01",
        "costumerNumber": "abc-123",
        "description": "",
        "email": "email@example.de",
        "email2": "email2@example.de",
        "phoneWork": "123456/987654",
        "phonePrivate": "123456-987654",
        "phoneMobile": "123456789",
        "fax": "",
        "facebook": "",
        "twitter": "",
        "xing": "",
        "linkedin": ""
    }]
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <persons>
            <person>
                <hash>3957d580698c3345c9a962e077c44961</hash>
                <assignedOrganisationHash>01ed57dc391c5a58808b9087a466ef78</assignedOrganisationHash>
                <labels/>
                <projects>
                    <project_0>
                        <hash>661dfc3980899852736864b4e43cd374</hash>
                        <name>XOVI Suite | Online Marketing Tool</name>
                    </project_0>
                </projects>
                <honorific>titlevalue</honorific>
                <firstname>firstnamevalue</firstname>
                <lastname>lastnamevalue</lastname>
                <function>functionvalue</function>
                <birthday>2000-01-02</birthday>
                <costumerNumber>123</costumerNumber>
                <description>beschreibungavlue</description>
                <email>emailvalue</email>
                <email2>emailvalue2</email2>
                <phoneWork>phonewordvalue</phoneWork>
                <phonePrivate>phoneprivatevalue</phonePrivate>
                <phoneMobile>phonemodilevalue</phoneMobile>
                <fax>faxvalue</fax>
                <facebook>facebookvalue</facebook>
                <twitter>twittervalue</twitter>
                <xing>xongvalue</xing>
                <linkedin>linkedinvalue</linkedin>
            </person>
        </persons>
    </apiResult>
</result>