Versions Compared

Old Version 6

changes.mady.by.user Jana Höfer

Saved on

compared with

New Version 7

changes.mady.by.user Katharina Marxreiter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Die hier referenzierte PEIQ Ad API (Beta) befindet sich noch im Modus Beta und ist teilweise noch “work in progress”

...

Note

Eine Ausnahme gibt es bei Adressen:

  • Wenn "scope": "all" mitgegeben wird, dann müssen alle CIDs der Adressen (über vorher angelegte Adressen im Endpunkt POST /adresses) einer Adressart im Feld “numbers” mitgeliefert werden, die in PEIQ vorhanden sein sollen.

  • Bei "scope": "active only" wird nur eine Adresse mitgeliefert und diese in PEIQ als ab sofort gültige Adresse übernommen. Alle bisherigen Adressen dieser Adressart werden in PEIQ behalten und als nicht mehr gültig markiert.

...

Die Suche nach Geschäftspartnern kann mit vorgegebenen Suchkriterien eingegrenzt werden. Bei der Suche können verschiedene Parameter angegeben werden:

Parameter

Beschreibung

limit

Begrenzung des Suchergebnisses auf eine bestimmte Anzahl.

offset

Initial leer.

Werden mehr Geschäftspartner gefunden, als im limit definiert wurde, kann die Suche mit dem gelieferten offset fortgesetzt werden, um den nächsten Block zu finden.

name

Nachname / Name

first_name

Vorname / Name2

street_name

Straßenname

zip

Postleitzahl

city

Ort

country

Land

phone_number

Telefonnummer

area_code

Vorwahl

country_code

Ländervorwahl

email

Email-Adresse

Suchbedingungen

  • Bei der Suche dürfen nur die Parameter angegeben werden, zu denen auch Werte geprüft werden sollen.

  • Bei der Suche werden nur Geschäftspartner berücksichtigt, die dem Modul Werbemarkt zugeordnet sind.

  • Eine Wildcard-Suche ist mit * möglich.
    Sollen alle Geschäftspartner gefunden werden, deren Nachname mit "Ma" beginnt, so ist die Suche mit name=ma* einzuschränken.

  • Bei Suche nach einem bestimmten Ort werden alle Adressen (Haupt,- Rechnungs- und weitere Adressen, aktuelle und nicht mehr gültige) durchsucht. So erhält man z.B. als Ergebnis einen Geschäftspartner, der zum gesuchten Ort nur eine Rechnungsadresse hat.

  • Die Suche kann nach nach Vorwahl und Ländervorwahl eingeschränkt werden. Dabei müssen die Werte so angegeben werden, wie sie in NGen gespeichert sind, oder mit Wildcard * - z.B. country_code=*49 für Geschäftspartner mit Telefonnummer in Deutschland.

...