User-Ressourcen REST API

Einführung

In diesem Teil erhalten Sie Informationen, wie auf sämtliche Teilnehmer zugegriffen werden kann.

Allgemeine Information

Diese Ressource unterstützt die folgenden Operationen:

Name	URL	GET	POST	PUT	DELETE	Status
Teilnehmer	v1/users	Ja	Ja	Ja	–

Wenn Sie auf diese Ressource zugreifen möchten, verwenden Sie folgende URL:

Ressource URL

https://api.edoobox.com/v1/users

Definitionen

GET Parameter für Abfrage

Sämtliche Parameter, welche bei einer GET Anfrage enthalten sein können oder erforderlich sind:

Parameter	Art	Beschreibung	Erforderlich
language	String	Sprache z.B. „de“ oder en, fr, es, cn, cs	Ja
limit > start	Integer	Ab welcher Position ausgeben, Paging	–
limit > reply	Integer	Anzahl Antworten, max. 100	–
filter > id	Array	Nur ein bestimmtes Angebot ausgeben property > user.id *value* String, user_abc_1234	–
filter > last_name	Array	Suchen im Nachnamen *property* > user.last_name needle String, Max 20 Zeichen	–
filter > first_name	Array	Suchen im Vornamen *property* > user.first_name needle String, Max 20 Zeichen	–
filter > email	Array	Suchen in E-Mail *property* > user.email needle String, Max 20 Zeichen	–
filter > offer.id	Array	Nur Teilnehmer von einem bestimmten Angebot *property* > offer.id value String, „offer_abc_1234“	–
filter > booking.id	Array	Nur Teilnehmer einer bestimmten Buchung *property* > booking.id value String, „booking_abc_1234“	–
order > last_name	Array	Sortieren nach dem Nachnamen *property* > user.last_name value String, „ASC“ oder „DESC“	–
order > first_name	Array	Sortieren nach dem Vornamen *property* > user.first_name value String, „ASC“ oder „DESC“	–
order > id	Array	Sortieren nach der User ID *property* > user.id value String, „ASC“ oder „DESC“	–

Rückgabewerte

Die Rückgabe ist in jedem edoobox Konto individuel. Es wird die aktivierte Datenstruktur von Ihrem Konto verwendet, somit werden nur die Datenfelder-Werte zurückgegeben, die aktiviert sind.

Feld	Art	Beschreibung	Objekt
id	String	edoobox ID
status	Boolean	Ist der Teilnehmer aktiv
gender	String	Geschlecht des Teilnehmers „woman“ oder „man“
first_name	String	Vorname
last_name	String	Nachname
street	String	Strasse
postcode	String	Postleitzahl
location	String	Ort
country_id	String	edoobox ID vom Land	Land
language	String	Sprache z.B. „de“
company	String	Firma
phone_number	String	Telefon
email	String	E-Mail
data_1 > data_30	String	Zusätzliche 30 Datenfelder welche immer mit „data_“ starten und mit der einmaligen Integer ID definiert werden
booking_id	String	edoobox ID der Buchung. Wird der Filter „offer.id“ gesetzt, wird dieser Wert zurück gegeben	Buchung

GET Beispiel

Dazu ein Beispiel, wie diese Parameter im GET-Request übergeben werden. Dieses Beispiel enthält alle Parameter, somit müssen erst die unnötigen Parameter entfernt werden:

	<?php
	$client->get('users', array(
	'language' => 'de',
	'filter' => array(
	array(
	'property' => 'user.id',
	'value' => 'user_abc_1234'
	),
	array(
	'property' => 'user.last_name',
	'needle' => 'test'
	),
	array(
	'property' => 'user.first_name',
	'needle' => 'test'
	),
	array(
	'property' => 'user.email',
	'needle' => 'test@name.com'
	),
	array(
	'property' => 'offer.id',
	'value' => 'offer_abc_1234'
	),
	array(
	'property' => 'booking.id',
	'value' => 'booking_abc_1234'
	)
	),
	'limit' => array('start' => 0,
	'reply' => 10),
	'order' => array(
	array( 'property' => 'user.last_name',
	'value' => 'DESC'
	),
	array( 'property' => 'user.first_name',
	'value' => 'DESC'
	),
	array( 'property' => 'user.id',
	'value' => 'DESC'
	)
	)
	));

view raw get_user_sample1.php hosted with ❤ by GitHub

Updated on 5. März 2020

Was this article helpful?

Yes No

Die Lösung nicht gefunden?

Dann erstellen Sie eine Support-Anfrage.

Support Ticket