Zum Hauptinhalt springen
API docs by Redocly

Portalverbund - Suchdienst REST-API (9.12.0)

Download OpenAPI specification:Download

URL: https://www.fitko.de/ License: Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)

Das Portalverbund-Onlinegateway (PVOG) stellt zentral die Verwaltungsleistungen von Bund und Ländern bereit. Die Aufgabe des Suchdienstes ist es, die bereitgestellten Verwaltungsleistungen anwendergerecht und öffentlich durchsuchbar und auffindbar zu machen. Die vom Suchdienst bereitgestellte REST-API bietet verschiedene Endpunkte zum Durchsuchen des Datenbestands des PVOG.

Organisationseinheiten

Endpunkte für den Zugriff auf Organisationseinheiten. Zumeist Behörden sind diese Organisationen die Orte der Inanspruchnahme der gesuchten Leistung. Einer gesuchten Leistung können mehrere Organisationseinheiten zugeordnet sein.

Gibt die Organisationseinheit zurück

Gibt die Organisationseinheit mit der angeforderten ID zurück. Die Rolle sowie die Kontaktpersonen der Organisationseinheit ergeben sich aus der übergebenen 'lbId'. Wird keine 'lbId' übergeben, wird die Rolle auf 'Ansprechpunkt' gesetzt.

Authorizations:
OAUTH2
query Parameters
q
required
string [ 2 .. 2147483647 ] characters

Die ID der Organisationseinheit

ars
string [ 2 .. 12 ] characters

Filtert die Kontaktpersonen anhand der räumlichen Zuständigkeit

lbId
string

Filtert Kontaktpersonen und Rollen anhand der Zuständigkeit für die Leistung mit dieser ID

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json
{
  • "id": "L100042.OE.868",
  • "languages": [
    ],
  • "lastUpdate": "2022-10-10T09:12:27.031512400Z",
  • "languageComplete": { },
  • "title": "Landgericht München I",
  • "forms": [ ],
  • "employees": [ ],
  • "additionalInformation": [ ],
  • "bankAccounts": [ ],
  • "location": {
    },
  • "communicationSystems": [ ],
  • "role": {
    }
}

Liefert die Titel, Rollen und Kriterien von Organisationseinheiten

Gibt die für eine Leistung zuständigen Organisationseinheiten mit ihrem Titel, sowie Rollen und Kriterien zurück

Authorizations:
OAUTH2
query Parameters
ars
required
string [ 0 .. 12 ] characters [0-9]*

Der ARS der Suche.

lbId
required
string

Die ID der Leistungsbeschreibung

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gibt die Organisationseinheit als jZuFi zurück

Gibt die Organisationseinheit als jZuFi zurück

Authorizations:
OAUTH2
query Parameters
q
required
string [ 2 .. 2147483647 ] characters

Die ID der Organisationseinheit

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json
{
  • "zustaendigkeit": [ ],
  • "formular": [ ],
  • "kontaktperson": [ ],
  • "id": {
    },
  • "idSekundaer": [ ],
  • "externeOrganisationseinheitsermittlung": false,
  • "untergeordneteOrganisationseinheitID": [ ],
  • "alternativeHierarchie": [ ],
  • "kategorie": [ ],
  • "name": [
    ],
  • "beschreibung": [ ],
  • "kurzbeschreibung": [ ],
  • "infoOeffnungszeitenText": [ ],
  • "infoOeffnungszeitenStrukturiert": [ ],
  • "infoInternServicecenter": [ ],
  • "infoSonstige": [ ],
  • "anschrift": [
    ],
  • "erreichbarkeit": [
    ],
  • "kommunikationssystem": [ ],
  • "internetadresse": [],
  • "bankverbindung": [ ],
  • "zahlungsweisen": [ ],
  • "zahlungsweisenText": [ ],
  • "synonym": [ ],
  • "sprachversion": [
    ],
  • "gueltigkeit": [
    ]
}

Onlinedienste

Endpunkte zum separaten Abrufen der Onlinedienste.

Liefert einen Onlinedienst

Liefert einen Onlinedienst mit der angeforderten ID zurück

Authorizations:
OAUTH2
query Parameters
q
required
string [ 2 .. 2147483647 ] characters

Die ID des Onlinedienstes

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json

Onlinedienst

{
  • "id": "L100042.OD.OD_xzufi22DeleteZSOD_77777_0001",
  • "name": "Link bzw. URL zum Online-Dienst",
  • "helpLinks": [ ],
  • "paymentMethods": [ ],
  • "identificationMethods": [ ],
  • "links": [],
  • "validityPeriods": [
    ],
  • "lastUpdate": "2022-10-06T07:24:24.356725600Z",
  • "parameters": [ ],
  • "executionLanguages": [ ],
  • "executionNationalities": [ ],
  • "levelOfConfidence": "10",
  • "languages": [
    ],
  • "languageComplete": {
    },
  • "arsFederalstate": [
    ],
  • "relations": [
    ],
  • "logos": [ ]
}

Leistungsbeschreibungen

Endpunkte zum Suchen und Finden von Verwaltungsleistungen. Sobald ein amtlicher Regionalschlüssel (ARS) ermittelt wurde, können Leistungsbeschreibungen (servicedescriptions) gesucht werden.

Dieser Endpunkt gibt die Leistungsbeschreibung und deren zugeordneten Lebenslagen aus.

Die Leistungsbeschreibung wird nach ARS und Lebenslagen gefiltert. Hier wird die Leistungsbeschreibung mit allen verknüpften Lebenslagen und deren Sublagen ausgegeben.

Authorizations:
OAUTH2
path Parameters
ars
required
string [ 0 .. 12 ] characters [0-9]*
Example: 01

Der ARS des Ortes, für den die Leistungsbeschreibung gelten soll. Falls der angegebene ARS kürzer als 12 Zeichen ist, wird der Wert mit Nullen aufgefüllt. Der ARS löst die Hierarchie nach oben hin auf.

query Parameters
personalMatters
Array of strings unique

Codes der Lebenslagen, nach denen gefiltert werden soll.

facades
boolean
Default: false

Bewirkt, dass die Schnittstelle zusätzlich zu den Treffern eine Aggregation der zugehörigen Lebenslagen liefert.

q
Array of strings [ 1 .. 2147483647 ] items
Example: q=Ingen

Der Wert, nach dem gesucht werden soll

page
integer <int32> [ 0 .. 100 ]
Default: 0

Ab Seite

size
integer <int32> [ 5 .. 9999 ]
Default: 10

Anzahl der Ergebnisse pro Seite

fuzzysearch
boolean
Default: false

Erlaubt eine Fuzzy-Suche

ignoreLeikaTypes
Array of strings unique
Default: ""

Ignoriert bestimmte Leika-Typisierungen der Liste urn:de:fim:leika:typisierung

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

useArsHierarchy
boolean
Default: true

Ob die Ars-Hierarchie bei der Suche berücksichtigt werden soll

Responses

Response samples

Content type
application/json
{
  • "serviceDescriptions": {
    },
  • "facades": {
    }
}

Gibt eine vollständige Leistungsbeschreibung.

Gibt eine Leistungsbeschreibung mit allen Informationen und allen zuständigen Organisationseinheiten in einem bestimmten Gebiet (ARS) zurück.

Authorizations:
OAUTH2
path Parameters
ars
required
string = 12 characters [0-9]*
Example: 010000000000

Wenn vorhanden, dann der ARS, ansonsten der AGS des Ortes, für den die Leistungsbeschreibung gelten soll

query Parameters
q
required
string [ 2 .. 2147483647 ] characters
Example: q=L100012.LB.9413106

Die ID der Leistungsbeschreibung, deren Details geladen werden sollen

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

useArsHierarchy
boolean
Default: true

Ob die Ars-Hierarchie bei der Suche berücksichtigt werden soll

Responses

Response samples

Content type
application/json
{
  • "name": "Schulform wechseln",
  • "description": "Sie wünschen für Ihr Kind einen Wechsel der Schulform? Dann können Sie einen Wechsel der Schulform bis zum Ende der Klasse 8 bei der Schule beantragen.",
  • "leikakeys": [
    ],
  • "sdgInformation": [
    ],
  • "id": "L100002.LB.00c33c8f98a69ac19c9ac945f4ffde1e",
  • "languageCode": "de",
  • "timestamp": "2022-11-11T12:57:07.808994100Z",
  • "ars": [
    ],
  • "sourcePortals": [],
  • "languageComplete": { },
  • "availableLanguages": [
    ],
  • "organisationIds": [
    ],
  • "lastUpdate": "2022-11-11T12:57:04.026993Z",
  • "externalLastUpdate": "2021-06-22T04:03:20Z",
  • "addressees": [ ],
  • "arsFederalstate": [
    ],
  • "validFrom": "1970-01-01",
  • "validTo": "2999-12-31",
  • "validityPeriods": [
    ],
  • "synonyms": [
    ],
  • "details": [
    ],
  • "typing": [
    ],
  • "onlineServiceLinks": [],
  • "personalMatters": [
    ],
  • "suggest": [
    ]
}

Liefert alle Leistungsbeschreibungen anhand des ARS in einer CSV Datei aus.

Ermöglicht das Abrufen aller Leistungsbeschreibungen in einer CSV Datei, die für den ARS erbracht werden (also für die es eine entsprechende räumliche Zuständigkeit gibt). Zusätzlich zu den Leistungsbeschreibungen werden die Onlinedienste geladen. Wenn zu einer Leistungsbeschreibung mehrere Onlinedienste vorhanden sind, dann wird je Onlinedienst eine Leistungsbeschreibung mit nur einem Onlinedienst ausgegeben. Aufbau der CSV-Datei:

  1. ID der Leistung,
  2. LeikaIds der Leistung,
  3. Bezeichnung der Leistung (Textmodul 02),
  4. Alternative Bezeichnung der Leistung (Textmodul 03),
  5. Letzter Updatezeitpunkt,
  6. ID des Onlinedienstes,
  7. Bezeichnung des Onlinedienstes,
  8. Url des Onlinedienstes

Authorizations:
OAUTH2
query Parameters
ars
required
string [ 0 .. 12 ] characters [0-9]*
Example: ars=01

Der ARS der Suche.

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json
"string"

Sucht mit einem LeiKa-Schlüssel nach Leistungsbeschreibungen.

Sucht nach Leistungsbeschreibungen anhand des jeweiligen LeiKa-Schlüssels in einem bestimmten Gebiet (ARS).

Authorizations:
OAUTH2
query Parameters
leikaIds
required
Array of strings
Example: leikaIds=99147006067000

Liste von Leika-Schlüsseln

q
Array of strings
Example: q=Ingenieur

Eine Liste mit zusätzlichen Suchbegriffen

ars
required
string [ 0 .. 12 ] characters [0-9]*
Example: ars=01

Der ARS des Ortes, für den die Leistungsbeschreibung gelten soll. Falls der angegebene ARS kürzer als 12 Zeichen ist, wird der Wert mit Nullen aufgefüllt. Der ARS löst die Hierarchie nach oben hin auf.

withOrgIds
boolean
Default: true

Legt fest, ob die Response organisationIds enthält

page
integer <int32> [ 0 .. 100 ]
Default: 0

Ab Seite

size
integer <int32> [ 5 .. 9999 ]
Default: 10

Anzahl der Ergebnisse ab Seite

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

useArsHierarchy
boolean
Default: true

Ob die Ars-Hierarchie bei der Suche berücksichtigt werden soll

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "pageable": {
    },
  • "numberOfElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "first": true,
  • "last": true,
  • "empty": true
}

Sucht nach den Leistungsbeschreibungen anhand der Hierarchie der Leika-Schlüssel.

Die übergebenen Leika-Schlüsel müssen alle auf der selben Ebene liegen, also alle entweder Verrichtungsdetail, Verrichtungskennung oder Leistungskennung.

Gesucht wird zuerst nach exakt übereinstimmenden Schlüsseln, aber unabhängig von der Länderkennung, sofern der jeweilige Schlüssel nicht den dezentralen Adressraum verwendet. Exakte Treffer werden per 'exact' Flag im 'meta' Objekt der Paginierung-Daten gekennzeichnet.

Gibt es keine direkten Treffer, werden spezifischere Leikas als die gesuchten gefunden.

Existieren auch diese nicht, wird nach übergeordneten Leikas gesucht.

Authorizations:
OAUTH2
query Parameters
leikaIds
required
Array of strings

Liste von gültigen Leika-Schlüsseln, temporäre Schlüssel der Form TMP_XX_... sind nicht erlaubt.

ars
required
string [ 0 .. 12 ] characters [0-9]*

Der ARS des Ortes für den die Leistungsbeschreibung gelten soll

ignoreLeikaTypes
Array of strings unique
Default: ""

Ignoriert bestimmte Leika-Typisierungen der Liste urn:de:fim:leika:typisierung

page
integer <int32> [ 0 .. 100 ]
Default: 0

Ab Seite

size
integer <int32> [ 5 .. 9999 ]
Default: 10

Anzahl der Ergebnisse ab Seite

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "meta": {
    },
  • "totalPages": 0,
  • "totalElements": 0,
  • "numberOfElements": 0,
  • "first": true,
  • "last": true,
  • "empty": true
}

JZuFi der Leistungsbeschreibung

Gibt das ursprüngliche JZuFi der Leistungsbeschreibung zurück

Authorizations:
OAUTH2
query Parameters
q
required
string [ 1 .. 255 ] characters
Example: q=L100012.LB.9413106

Die ID der Leistungsbeschreibung, deren Details geladen werden sollen

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

Responses

Response samples

Content type
application/json

in diesem Beispiel: Ingenieur / Ingenieurin: Erlaubnis zum Führen der Berufsbezeichnung

{
  • "id": {
    },
  • "idSekundaer": [
    ],
  • "struktur": {
    },
  • "referenzLeiKa": [
    ],
  • "modulText": [
    ],
  • "modulTextIndividuell": [ ],
  • "modulBegriffImKontext": [ ],
  • "modulUrsprungsportal": [],
  • "typisierung": [
    ],
  • "leistungsadressat": [ ],
  • "kennzeichenSchriftformerfordernis": false,
  • "kategorie": [
    ],
  • "klassifizierung": [ ],
  • "informationsbereichSDG": [ ],
  • "idLeistungImKontext": [ ],
  • "idProzess": [ ],
  • "gueltigkeitGebietID": [
    ],
  • "kennzeichenEA": false,
  • "relevantFuerWirtschaftszweig": [ ],
  • "relevantFuerRechtsform": [ ],
  • "relevantFuerStaatsangehoerigkeit": [ ],
  • "versionsinformation": {
    },
  • "sprachversion": [
    ],
  • "gueltigkeit": [ ]
}

Sucht nach Vorschlägen für die Leistungsbeschreibungen.

Sucht nach Vorschlägen für die Leistungsbeschreibungen. Es wird nach dem ARS gefiltert, die Anzahl der Vorschläge ist auf 5 begrenzt.

Authorizations:
OAUTH2
path Parameters
ars
required
string [ 2 .. 12 ] characters [0-9]*
Example: 01

Der ARS des Ortes für den der Suchvorschlag gelten soll.

query Parameters
q
required
Array of strings [ 1 .. 50 ] items
Example: q=Ingen

Der Wert, nach dem für die Vervollständigung gesucht werden soll

skipDuplicates
boolean
Default: false

Ob Mehrfachtreffer ignoriert werden sollen

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sucht nach allen Lebenslagen in einem Gebiet.

Gibt alle Lebenslagen gefiltert nach dem ARS aus. Es werden alle Lebenslagen, inklusive Sublagen angezeigt, für die in einem bestimmten Gebiet (ARS) Leistungsbeschreibungen vorhanden sind.

Authorizations:
OAUTH2
path Parameters
ars
required
string [ 0 .. 12 ] characters [0-9]*
Example: 090000000000

Der ARS des Ortes, für den die Leistungsbeschreibung gelten soll. Falls der angegebene ARS kürzer als 12 Zeichen ist, wird der Wert mit Nullen aufgefüllt. Der ARS löst die Hierarchie nach oben hin auf.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Statistik

Dieser Endpunkt liefert Statistiken über den Datenbestand aus.

Statistiken über Leistungsbeschreibungen, Organisationseinheiten, Onlinedienste und Spezialisierungen

Gibt Statistiken über vorhandene Leistungsbeschreibungen, Organisationseinheiten, Onlinedienste und Spezialisierungen zurück. Es werden pro Bundesland und Gesamt Deutschland die Anzahl der Objekte und der Zeitpunkt der letzten Änderung angegeben.

Authorizations:
OAUTH2

Responses

Response samples

Content type
application/json

erzeugt mit produktionsnahen Daten am 2022-07-20

{
  • "timestamp": "2022-07-20T10:15:32.595314627Z",
  • "stateServices": { },
  • "stateStatistics": [
    ]
}

Zuständigkeiten

Endpunkte zum Suchen und Finden von Zuständigkeiten.

Gibt das ursprüngliche JZuFi der Zuständigkeits-Objekte zurück.

Gibt das ursprüngliche JZuFi der Zuständigkeits-Objekte zurück. Ein Zuständigkeits-Objekt verknüpft Leistungsbeschreibungen, Organisationseinheiten und Onlinedienste.

path Parameters
ars
required
string [ 0 .. 12 ] characters [0-9]*

Der ARS des Ortes, für den die Zuständigkeiten gelten sollen

query Parameters
lbids
required
Array of strings [ 1 .. 50 ] items

Die IDs der Leistungsbeschreibungen, für die die Zuständigkeiten gelten sollen

validDate
string <date>

Das Gültigkeitsdatum in der Form yyyy-MM-dd

useArsHierarchy
boolean
Default: true

Ob die Ars-Hierarchie bei der Suche berücksichtigt werden soll

page
integer <int32> >= 0
Default: 0

Ab Seite

size
integer <int32> [ 5 .. 9999 ]
Default: 10

Anzahl der Ergebnisse pro Seite

Responses

Response samples

Content type
application/json

Liste mit den gefundenen Zuständigkeiten

"{\n \"content\": [\n {\n \"uebergeordnetesObjektID\": {\n \"value\": \"OE_xzufi22DeleteZSOD_77777_0001\",\n \"schemeAgencyID\": \"L100042\"\n },\n \"zustaendigkeit\": [\n {\n \"rolle\": {\n \"code\": \"03\",\n \"name\": \"Ansprechpunkt\",\n \"listURI\": \"urn:de:xzufi:codeliste:zustaendigkeitsrolle\",\n \"listVersionID\": \"20210401\"\n },\n \"id\": {\n \"value\": \"LB_xzufi22DeleteZSOD_77777_0001.OE_xzufi22DeleteZSOD_77777_0001.095640000003\",\n \"schemeAgencyID\": \"L100042\",\n \"schemeID\": \"ZustaendigkeitOrganisationseinheit\"\n },\n \"idSekundaer\": [\n {\n \"value\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJtaXNzaW9uSG9zdCI6InN1Ym1pc3Npb24tYXBpLXRlc3RpbmcuZml0LWNvbm5lY3QuZml0a28uZGV2IiwiaXNzIjoiaHR0cHM6Ly9wb3J0YWwuYXV0aC10ZXN0aW5nLmZpdC1jb25uZWN0LmZpdGtvLmRldiIsInNlcnZpY2VzIjpbeyJnZWJpZXRJRHMiOlsidXJuOmRlOmJ1bmQ6ZGVzdGF0aXM6YmV2b2Vsa2VydW5nc3N0YXRpc3RpazpzY2hsdWVzc2VsOnJzOjEyMzEyMzEyMzEyMyJdLCJsZWlzdHVuZ0lEcyI6WyJ1cm46ZGU6ZmltOmxlaWthOmxlaXN0dW5nOkxCX3h6dWZpMjJEZWxldGVaU09EXzc3Nzc3XzAwMDIiXX1dLCJkZXN0aW5hdGlvbklkIjoiN2I0OWNlYWQtNDQ4My00OTczLWJiZTctODZlYWExNzFjOTkzIiwiaWF0IjoxNjg4NTY1NzcxLCJqdGkiOiI1YmI2ODZmMS1hOGI1LTRiNjItYmU3NC02MDIyZjhmZWIwMmIifQ.scU5RTTc0CeG60VgECB2M3mxVFG5XLltPn8iYYR3XExj_PvkXk9BQoMZNQIHVG07YniAedfoJvJJzhxcnhaVau-20uNgKljtlicANMPaFIFD9CtidUuy04OKf-RvYVwvIM6-8uHvhqV7fzdkzLBlbMni8XQjoeBpHWd6lFYL8Hzak55cAbjU2G1-2LXou2etVBMYCISTQ_K-CvM_f-4R_FFgE9t1nfYjJAZkYaWdJ9iS9xu5rgw_0AJymCkqKAWl1jdvSglPlsycpozXYn7duZjZ3nJNdZ3QmGCtLhRXyF2Y-9aOBCu4U0lYcMbn7rgVJG3KLNCMHGA_axnRDg88Yw\",\n \"schemeAgencyID\": \"urn:de:fitko\",\n \"schemeID\": \"urn:de:fitko:fit-connect:xzufi:destination\"\n },\n \"leistungID\": [\n {\n \"value\": \"LB_xzufi22DeleteZSOD_77777_0002\",\n \"schemeAgencyID\": \"L100042\"\n }\n ],\n \"gebietID\": [\n {\n \"value\": \"123123123123\",\n \"schemeAgencyID\": \"DESTATIS\",\n \"schemeID\": \"urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs\",\n \"schemeVersionID\": \"2018-07-31\"\n }\n ],\n \"gueltigkeit\": []\n }\n ]\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": true,\n \"sorted\": false,\n \"unsorted\": true\n },\n \"offset\": 0,\n \"pageSize\": 10,\n \"pageNumber\": 0,\n \"unpaged\": false,\n \"paged\": true\n },\n \"first\": true,\n \"last\": true,\n \"numberOfElements\": 1,\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"empty\": false\n}"

Orte

Um den für die Zuständigkeit notwendigen ARS zu ermitteln, kann die Ortssuche des Suchdienstes verwendet werden, sofern der ARS des Suchenden sich nicht aus einem anderen Kontext ermitteln lässt. Dazu bietet der Suchdienst die folgenden Schnittstellen.

Liefert eine Liste von Ortsdaten aus dem ARS-Index zurück

Liefert anhand des Wertes der Suchanfrage Orte aus dem ARS-Index zurück

Authorizations:
OAUTH2
query Parameters
q
required
string [ 2 .. 2147483647 ] characters

Der Name, die PLZ oder der ARS des Ortes, nach dem gesucht werden soll

limit
integer <int32> [ 1 .. 10 ]
Default: 10

Anzahl der Ergebnisse

fuzzysearch
boolean
Default: false

Gibt an, ob per Fuzzy Search Rechtschreibfehler korrigiert werden sollen.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Liefert eine Liste von Orten

Liefert Autovervollständigungs-Vorschläge für den Suchbegriff zurück (Präfixsuche).

Authorizations:
OAUTH2
query Parameters
q
required
string [ 1 .. 50 ] characters
Example: q=Neumün

Präfix des Namens oder der PLZ des Ortes für den die Autovervollständigung durchgeführt werden soll

size
integer <int32> >= 10
Default: 11

Anzahl der Ergebnisse

fuzzySearch
boolean
Default: false

Aktiviert die unscharfe Fuzzy-Suche, die auch Teilübereinstimmungen akzeptiert

fuzzyFirst
boolean
Default: false

Fuzzy-Ergebnisse vor (true) oder nach (false) normalen Treffern einordnen

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Liefert die Ortsdaten aus der Suchdienst Datenbank zu einem Breiten- und Längengrad zurück

Liefert anhand des Breitengrads und Längengrads einen Ort zurück. Diese Schnittstelle ist nur verfügbar, wenn das Feature GEOCODING aktiv ist.

Authorizations:
OAUTH2
query Parameters
lat
required
string

Der Breitengrad

lon
required
string

Der Längengrad

Responses

Response samples

Content type
application/json
[
  • {
    }
]