Kontakte abrufen¶

Übersicht¶

Kontakte sind im System hinterlegte Unternehmen oder private Personen. Sie stellen aus Sicht von CONNECT Kunden dar. Nach Vertragsabschluss werden diese Kontakte im System angelegt und sind über die API abrufbar¹.

Struktur¶

Alle Kontakte (und Ladestationen) sind einer Entität zugeordnet, damit die Zugriffe auf die Daten eingeschränkt werden kann. Jedem API Zugang werden Zugriffe auf entsprechende Entitäten gewehrt.

Entity relation — Zusammenhänge bei Kontakten

Kontakten können (digitale) Ladekarten zugeordnet werden. Eine (digitale) Ladekarte wird nur einem Konakt zugewiesen. Diesen kann man über das Feld contact zuordnen. Außerdem können alle Ladekarten eines Kontaktes abgerufen werden.

Abweichender Rechnungsempfänger

In manchen Fällen kann es sein, dass der contactund der billing_contactauf unterschiedliche Kontakte verweisen. In dem Fall hat nur der contact Zugriff auf die Ladekarte und kann diese Nutzen. Alle mit der Karte getätigten Ladevorgänge werden dann mit dem billing_contact abgerechnet.

Kontakte abrufen¶

Je nach Szenario gibt es verschiedene Möglichkeiten, Kontakte über unsere API abzurufen.

Wählen Sie einen bestimmten Kontakt aus getContact
Alle verfügbaren Kontakte auswählen getContacts

Hier ist eine Beispielanfrage mit der die Kontakte abgerufen werden können:

query getContacts($limit: Int, $offset: Int) {
  getContacts(limit: 100, offset: 0) {
    birthday
    customerNumber
    email
    fax
    gender
    givenName
    id
    isCompany
    location {
      ...LocationFragment
    }
    name
    phone
  },
  ...
}

Die Beschreibung der einzelnen Felder sind in Contact definiert.

Angaben zu limit, offset und total

Standardmäßig gibt diese Abfrage maximal 1000 Objekte zurück. Sollten mehr Kontakte verfügbar sein, erkennt man das an total welches die Anzahl der Kontakte die in Summe abgefragt werden können angibt.

Aufgelistete Kontakte sind abhängig von den Zugriffsrechten

Die in der Antwort aufgelisteten Kontakte sind von den Zugriffsrechten abhängig. Diese werden im System festgelegt und erlauben nur Zugriff auf die Kontakte, die einem zugewiesen wurden.

Sofern sie der Entität, also dem API Zugang, zugeordnet wurden. ↩