Adressen auflisten (REST API)

Diese Artikel könnten auch für Sie interessant sein:
Kontakt anlegen.

Sortiert nach Suchbegriff aufsteigend.

Als Parameter können Filter übergeben werden.
Es kann nach folgenden Feldern gefiltert werden:

Feld Typ Bedeutung
MainCategory Text Name einer Hauptkategorie
Tag Text Cloud: Name eines Tags
WebAccess: Name einer Adresskategorie
Fulltext Text Alle Adressen, deren Name (Firmenname, Vorname oder Nachname) diesen Text enthält.
Weitere Felder der Adresse werden nicht durchsucht.
City Text Städtenamen kommagetrennt (z.B. Erlangen, Nürnberg)
ZipCodes Text Postleitzahlen kommagetrennt (z.B. 7, 8, 91054, 91056)
Es können sowohl vollständige PLZ angegeben werden als auch Teile, um nach PLZ-Bereichen zu Suchen (z.B. "7, 8", um alle Adressen aus den PLZ 70000-89999 zu filtern.
Country Text Ländernamen kommagetrennt (z.B. Deutschland, Schweiz)
HasEMailAddress Bool Bestimmt, ob nur Adressen mit E-Mail-Adressen geliefert werden.
Mögliche Werte:
True: Nur Adressen mit E-Mail-Adresse werden aufgelistet
False: Nur Adressen ohne E-Mail-Adresse werden aufgelistet
IsActive Bool

Standardmäßig werden nur aktive Adressen geliefert.
Sollen inaktive Adressen geliefert werden, muss dieser Wert auf "False" gesetzt werden.

Skip Int Anzahl der Adressen, die übersprungen werden sollen
Take Int Anzahl der Adressen, die zurückgeliefert werden sollen

 

Beispiel: <apiurl>/api/contact?MainCategory=Kunde

In diesem Beispiel werden alle Kunden zurückgeliefert.

 

 

Haben Sie Fragen? Anfrage einreichen

Kommentare

Powered by Zendesk