1. Home
  2. REST API edoobox
  3. User-Ressourcen REST API

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:

NameURLGETPOSTPUTDELETEStatus
Teilnehmerv1/usersJa 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 BeschreibungErforderlich
language String Sprache z.B. „de“
oder en, fr, es, cn, cs
 Ja
limit > startIntegerAb welcher Position ausgeben, Paging
limit > replyIntegerAnzahl Antworten, max. 100
filter > id Array Nur ein bestimmtes Angebot ausgeben

  • property > user.id
  • value
    String, user_abc_1234
 –
filter > last_nameArraySuchen im Nachnamen

  • property > user.last_name
  • needle
    String, Max 20 Zeichen
filter > first_nameArraySuchen im Vornamen

  • property > user.first_name
  • needle
    String, Max 20 Zeichen
filter > emailArraySuchen in E-Mail

  • property > user.email
  • needle
    String, Max 20 Zeichen
filter > offer.idArrayNur Teilnehmer von einem bestimmten Angebot

  • property > offer.id
  • value
    String, „offer_abc_1234“
 –
filter > booking.idArrayNur Teilnehmer einer bestimmten Buchung

  • property > booking.id
  • value
    String, „booking_abc_1234“
 –
order > last_nameArraySortieren nach dem Nachnamen

  • property > user.last_name
  • value
    String, „ASC“ oder „DESC“
 –
order > first_nameArraySortieren nach dem Vornamen

  • property > user.first_name
  • value
    String, „ASC“ oder „DESC“
 –
order > idArraySortieren 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.

FeldArtBeschreibung Objekt
idStringedoobox ID
statusBooleanIst der Teilnehmer aktiv
genderStringGeschlecht des Teilnehmers „woman“ oder „man“
first_nameStringVorname
last_nameStringNachname
streetStringStrasse
postcodeStringPostleitzahl
locationStringOrt
country_idStringedoobox ID vom Land Land
languageStringSprache z.B. „de“
companyStringFirma
phone_numberStringTelefon
emailStringE-Mail
data_1 > data_30StringZusätzliche 30 Datenfelder welche immer mit „data_“ starten und mit der einmaligen Integer ID definiert werden
booking_idStringedoobox ID der Buchung. Wird der Filter „offer.id“ gesetzt, wird dieser Wert zurück gegebenBuchung

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:

Updated on 23. August 2019

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support