Skip to content

Contact ​

Kontakte durchsuchen und abrufen. Neben der Volltextsuche über die eigenen Kontakte (search, getjustiz) steht eine erweiterte Suche über das aktive Unternehmenszertifikat zur Verfügung (extendsearch, asynchrones Ergebnis).

Kontakt suchen ​

POST KUNDEN-HMAC /contact/search

Volltextsuche über die eigenen Kontakte. Durchsucht werden u. a. Name, Justiz-ID, Adresse, E-Mail, Telefon und Rolle. Pro Seite werden bis zu 100 Treffer geliefert.

Request-Body (form-data) ​

FeldBeschreibungBeispiel
searchSuchbegriff (Pflicht, 3–100 Zeichen)DE.Justiz.f8d8388f-1a64-

Response ​

Paginiertes Suchergebnis: search enthält die Paginierung (found, per_page, current_page, total_pages), data die Trefferliste (bis zu 100 Dokumente pro Seite):

json
{
  "search": {
    "found": 12,
    "per_page": 100,
    "current_page": 1,
    "total_pages": 1
  },
  "data": [
    {
      "contact_ID": "<uuid>",
      "contact_justiz_ID": "<safe-id>",
      "...": "..."
    }
  ]
}
FeldTypBeschreibung
data[].contact_IDstringInterne Kontakt-ID
data[].contact_justiz_IDstringJustiz-ID / Safe-ID des Kontakts
data[].contact_full_namestringVollständiger Name
data[].contact_first_name / contact_last_namestringVor- und Nachname
data[].contact_street_name / contact_house_numberstringStraße und Hausnummer
data[].contact_postal_code / contact_city / contact_countrystringPLZ, Ort, Land
data[].contact_email / contact_phone / contact_faxstringKontaktdaten
data[].contact_role_name / contact_egvp_rolestringRolle des Kontakts

Mögliche Fehler ​

CodeMeldungBedingung
406validationinvalidsearch fehlt, ist kürzer als 3 oder länger als 100 Zeichen; page nicht numerisch
403access deniedHMAC-Signatur ungültig oder abgelaufen, hmac_unique wiederverwendet oder Origin nicht freigegeben
500–Interner Fehler – generische Meldung
503–Rate-Limit überschritten (250 Requests/s pro IP)

Kontakt per Justiz-ID abrufen ​

POST KUNDEN-HMAC /contact/getjustiz

Liefert den Kontakt, der zur angegebenen Justiz-ID (Safe-ID) gehört.

Request-Body (form-data) ​

FeldBeschreibungBeispiel
contact_justiz_IDJustiz-ID des gesuchten Kontakts (Pflicht, 10–100 Zeichen)DE.Justiz.f8d8388f-1a64-4d23-bfe9-38d58f4c4ee4.973d

Response ​

Kontakt-Objekt mit allen hinterlegten Feldern (Adresse, Kommunikationsdaten, Rolle).

Mögliche Fehler ​

CodeMeldungBedingung
404contact could not be foundKein Kontakt mit dieser Justiz-ID vorhanden
406validationinvalidcontact_justiz_ID fehlt oder Länge außerhalb 10–100
403access deniedHMAC-Signatur ungültig oder abgelaufen, hmac_unique wiederverwendet oder Origin nicht freigegeben
500–Interner Fehler – generische Meldung
503–Rate-Limit überschritten (250 Requests/s pro IP)

Erweiterte Kontaktsuche (asynchron) ​

POST KUNDEN-HMAC /contact/extendsearch

Startet eine erweiterte Kontaktsuche über das aktive Unternehmenszertifikat (z. B. externes Verzeichnis). Das Ergebnis wird nicht synchron geliefert – die Response enthält eine datahandler_ID, über die das Ergebnis anschließend per POST /datahandler/get/{id} abgerufen wird.

Request-Body (form-data) ​

FeldBeschreibungBeispiel
contact_organisationOrganisation des Kontakts (max. 300)–
contact_alternative_organizationAlternative Organisation (max. 200)–
contact_form_addressAnschriftform (max. 200)–
contact_titleTitel (max. 50)–
contact_first_nameVorname (max. 100)–
contact_last_nameNachname (max. 100)–
contact_profession_propertyBerufsmerkmal (max. 200)–
contact_role_nameRolle (max. 100)–
contact_stateBundesland (max. 50)–
contact_justiz_IDJustiz-ID (max. 100)–
contact_street_nameStraße (max. 200)–
contact_house_numberHausnummer (max. 50)–
contact_cityOrt (max. 200)–
contact_postal_codePLZ (max. 20)–

Weitere Request-Felder (form-data/JSON) ​

FeldBeschreibungBeispiel
cert_IDOptional: UUID v4 des zu verwendenden Zertifikats–

Response ​

Die datahandler_ID zum Abruf des asynchronen Ergebnisses über datahandler/get/{datahandler_ID}:

json
{
  "datahandler_ID": "<uuid>"
}

Mögliche Fehler ​

CodeMeldungBedingung
404cert could not be foundEs sind keine Zertifikate hinterlegt
404no active cert foundKein aktives Zertifikat vorhanden
409more than one active cert foundMehrere aktive Zertifikate – cert_ID zur Auswahl mitsenden
406validationinvalidFeld-Constraints verletzt oder cert_ID keine UUID v4
403access deniedHMAC-Signatur ungültig oder abgelaufen, hmac_unique wiederverwendet oder Origin nicht freigegeben
500–Interner Fehler – generische Meldung
503–Rate-Limit überschritten (250 Requests/s pro IP)

Mit 🌈 entwickelt in Berlin 🐻 & Köln ⛪
Hosting zu 100% in Deutschland 🇩🇪