Zum Hauptinhalt springen

IF_010, IF_016 – Suche nach Verwaltungsleistungen (API)

Die web-basierte Programmierschnittstelle (API) des Suchdiensts folgt den Prinzipien des RESTParadigmas und nutzt JSON als Datenformat. Über verschiedene Endpunkte werden die notwendigen Methoden für eine deutschlandweite Suche nach Verwaltungsleistungen bereitgestellt.

Endpunkte​

Der Suchdienst stellt die Methoden für die maschinelle Suche nach Verwaltungsleistungen über das Internet zu Verfügung. Die Bereitstellung der Methoden erfolgt auf Basis eines Versionierungskonzeptes. Neue oder angepasste Methoden sind über neue Endpunkte zu erreichen. So gibt es beispielsweise in der ersten Version der Schnittstelle (v1 = Version 1) Methoden für die Suche nach Verwaltungsleistungen, Organisationseinheiten (zuständige Stellen) und Ortsangaben. Diese Methoden wurden, bzw. werden (schrittweise) angepasst, erweitert und ergänzt und in nachfolgenden Versionen der Schnittstelle (z. B. v2 = Version 2) zur Verfügung gestellt. Der Zugriff auf die Methoden erfolgt über die Endpunkte der jeweiligen Schnittstellenversionen. Details zu den Schnittstellen sind in der Schnittstellen-Dokumentation auf dem PVOG Produktportal (öffnet in neuem Tab) abrufbar.

Die folgenden Abschnitte geben einen ersten Überblick über die grundsätzliche Funktionsweise der Schnittstelle.

Authentifizierung​

Die Verwendung der Schnittstelle erfordert keine Authentifizierung, sondern kann anonym genutzt werden.

Nutzungsfrequenz​

Die Nutzungsfrequenz ist abhängig von der Anzahl der Verwaltungskunden, die eine deutschlandweite Suche nach Verwaltungsleistungen in den angebundenen Verwaltungsportalen der Portalverbundteilnehmer nutzen wollen und der Häufigkeit der Nutzung. Im Rahmen des Projekts wurden Prognosen bzgl. der Nutzungsfrequenz dieser Schnittstelle auf Basis unterschiedlicher Nutzungsszenarien erstellt. Im Dokument „Konzept Anforderungen an Last und Performance an das Online-Gateway Portalverbund (öffnet in neuem Tab, Download)“ werden die Szenarien und die daraus abzuleitenden Anforderungen bzgl. der Nutzungsfrequenz für diese Schnittstelle näher beschrieben.

Verschlüsselung der Übertragungswege​

Vgl. Beschreibung IF_009.

Nachrichtenformate​

Abfrage​

Die maschinelle Schnittstelle des Suchdienstes verwendet REST-Services, die über HTTPS-GETRequests aufgerufen werden können. Die entsprechenden Methoden können wie folgt verwendet werden.

Ergebnis​

Der Suchdienst liefert das Suchergebnis im JSON-Format. Die JSON-Struktur orientiert sich dabei an XZuFi Version 2.2. In den folgenden Abschnitten werden die Nachrichtenformate für die jeweiligen Ergebnisse der einzelnen Methoden überblicksartig anhand einzelner Beispiele dargestellt.

Methodenübersicht für Nachrichtenformate​

Methode /v1/locations​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v1/locations

Beschreibung​

Methode, um für eine Ortsangabe den zugehörigen amtlichen Regionalschlüssel (ARS) abzufragen.

Parameter​
NameBedeutungBeispiel
qOrt, für den eine Verwaltungsleistung gesucht wird.q=Halle
Beispiel​

https://mein.server.de/suchdienst/api/v1/locations?q=Halle (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
[
{
"name": "Halle",
"ars": "032555408016",
"zip": "37620",
"suggest": {
"weight": "00000001528",
"input": ["Halle", "37620"]
}
},
{
"name": "Halle",
"ars": "034565404008",
"zip": "49843",
"suggest": {
"weight": "00000000659",
"input": ["Halle", "49843"]
}
},
{
"name": "Halle (Westf.), Stadt",
"ars": "057540012012",
"zip": "33790",
"suggest": {
"weight": "00000021692",
"input": ["Halle (Westf.), Stadt", "33790"]
}
},
{
"name": "Halle (Saale),Stadt",
"ars": "150020000000",
"zip": "06108",
"suggest": {
"weight": "00000238005",
"input": ["Halle (Saale), Stadt", "06108"]
}
}
]

Methode /v1/locations/suggestions​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v1/locations/suggestions

Beschreibung​

Methode zum Abfragen von maximal 10 Vorschlägen zur automatischen Vervollständigung einer Ortsangabe.

Parameter​
NameBedeutungBeispiel
qUnvollständige Ortsangabe, für die eine Vervollständigung angefragt wird.q=Hall
Beispiel​

https://mein.server.de/suchdienst/api/v1/locations/suggestions?q=Hall (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
[
{
"name": "Halle (Saale), Stadt",
"ars": "150020000000",
"zip": "06108",
"suggest": {
"weight": "00000238005",
"input": ["Halle (Saale), Stadt", "06108"]
}
},
{
"name": "Halle (Westf.),Stadt",
"ars": "057540012012",
"zip": "33790",
"suggest": {
"weight": "00000021692",
"input": ["Halle (Westf.), Stadt", "33790"]
}
},
{
"name": "Hallenberg, Stadt",
"ars": "059580020020",
"zip": "59969",
"suggest": {
"weight": "00000004474",
"input": ["Hallenberg, Stadt", "59969"]
}
},
{
"name": "Hallerndorf",
"ars": "094740133133",
"zip": "91352",
"suggest": {
"weight": "00000004151",
"input": ["Hallerndorf", "91352"]
}
},
{
"name": "Halle",
"ars": "032555408016",
"zip": "37620",
"suggest": {
"weight": "00000001528",
"input": ["Halle", "37620"]
}
},
{
"name": "Halle",
"ars": "034565404008",
"zip": "49843",
"suggest": {
"weight": "00000000659",
"input": ["Halle", "49843"]
}
}
]

Methode /v1/servicedescriptions/suggests/{ars}​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v1/servicedescriptions/suggestions/{ars}

Beschreibung​

Methode zum Abfragen von maximal 10 Vorschlägen zur automatischen Vervollständigung einer Verwaltungsleistung.

Parameter​
NameBedeutungBeispiel
qUnvollständige Angabe einer Verwaltungsleistung, für die eine Vervollständigung angefragt wird.q=Sport
skipDuplicatesAngabe, ob Duplikate gefiltert werden sollen (=true) oder nicht (=false)skipDuplicates=true
Beispiel​

https://mein.server.de/suchdienst/api/v1/servicedescriptions/suggestions/020000000000?q=Sport (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
[
{
"suggestedText": "sport",
"name": "sport",
"id": "NtdKJW0B3mno2oz9iYEq"
},
{
"suggestedText": "sport",
"name": "sport",
"id": "zddKJW0B3mno2oz9hICs"
},
{
"suggestedText": "sportamt",
"name": "sportamt",
"id": "utdJJW0B3mno2oz9wnAk"
},
{
"suggestedText": "sportbund",
"name": "sportbund",
"id": "KNdJJW0B3mno2oz9wnAk"
},
{
"suggestedText": "sportförderung",
"name": "sportförderung",
"id": "u9dJJW0B3mno2oz9wnAk"
}

]

Methode /v2/servicedescriptions/{ars}​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v2/servicedescriptions/{ars}

Beschreibung​

Methode zum Abfragen von Verwaltungsleistungen für ein Verwaltungsgebiet, definiert über die ARS-Angabe im Pfad.

Parameter​
NameBedeutungBeispiel
qSuchbegriff für Verwaltungsleistungq=Sport
pageSeite im Suchergebnispage=1
sizeAnzahl der Ergebnisse ab Seitesize=10
Beispiel​

https://mein.server.de/suchdienst/api/v2/servicedescriptions/020000000000?page=1&q=Sport&size=10 (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
{
"content": [
{
"addressees": ["Bürger", "Unternehmen"],
"arsFederalstate": ["02"],
"description": "Kinder unter 18 Jahren, die (oder deren Eltern) Leistungen nach dem SGB II (Arbeitslosengeld II / Hartz IV / Sozialgeld), dem SGB XII (Grundsicherung / Sozialhilfe), §§ 2 oder 3 Asylbewerberleistungsgesetz, Wohngeld oder Kinderzuschlag erhalten,können monatlich bis zu 10,- Euro erhalten. Diese Leistungen werden unter Vorlage des Nachweises der Leistungsberechtigung (Bewilligungs- oder Kurzbescheid) direkt bei den Leistungsanbietern beantragt. Eine Liste der Leistungsanbieter finden Sie unter Links. Die Abrechnung erfolgt direkt zwischen Leistungsanbieter und der Stadt Hamburg. Gefördert werden zum Beispiel: , Führungen im Museum, Jahreskarte der Bücherhallen, Musikunterricht, Sport in Sportvereinen, die Teilnahme an Freizeiten (zum Beispiel Pfadfinder). Ansparen für Freizeiten Für Freizeiten können die Monatsbeiträge für bis zu 12 Monate innerhalb eines Bewilligungszeitraums angespart werden (siehe hierzu auch Link 'Bildungspaket - Ansparen für Freizeiten'). Ausrüstungsgegenstände: Alternativ kann der Betrag von maximal 10 Euro monatlich auch für Ausrüstungsgegenstände oder andere Aufwendungen im Zusammenhang mit Teilhabeaktivitäten eingesetzt werden. Diese können sowohl gekauft, als auch beim jeweiligen Veranstalter der Aktivität ausgeliehen werden. Allerdings muss der jeweilige Ausrüstungsgegenstand unmittelbar für die Aktivität, an der das Kind teilnimmt, benötigt werden. Weiterhin muss es sich um Ausrüstungsgegenstände handeln, die nicht zum Alltagsbedarf gehören. So sind schlichte Sportschuhe Teil des Alltagsbedarfs. Fußballschuhe hingegen können, sofern das Kind an einem entsprechenden Angebot teilnimmt, als Ausrüstungsgegenstand geltend gemacht werden. Das Formular 'Beschaffung von Ausrüstungsgegenständen' mit dem Ausrüstungsgegenstände beantragt werden können, liegt in den Sozialen Dienstleistungszentren bzw. Fachämtern für Grundsicherung und Sozialessowie in den Standorten von Jobcentern aus. Der Leistungsanbieter bestätigt die Teilnahme des Kindes bzw. des Jugendlichen an einem seiner Angebote und trägt die anfallenden Kosten ein. Das ausgefüllte Formular ist vom Leistungsberechtigten an folgende Adresse zu senden:Bezirksamt Eimsbüttel Fachamt Grundsicherung und Soziales Bildung und Teilhabe Abrechnungsstelle Grindelberg 62-66 20144 Hamburg E-Mail: bildungspaket@eimsbuettel.hamburg.de",
"id": "S100002LBS1000020010000006117",
"languageCode": "de-DE",
"name": "Bildungspaket - Kostenerstattung für Kultur, Musik und Sport",
"nameOtherDescription": "Bildungspaket - Kostenerstattung für Kultur, Musik und Sport",
"organisations": [
{
"ags": [],
"ars": ["020000000000"],
"organisationId": "S100002OES1000020020000000023"
}
],
"sourcePortal": {
"description": "Link zur Leistung im Ursprungsportal",
"link": {
"description": "Behördenfinder Hamburg",
"title": "Behördenfinder Hamburg",
"uri": "https://www.hamburg.de/behoerdenfinder/hamburg/d115/99107032000000"
},
"title": "Leistung im Ursprungsportal"
},
"specializations": [],
"suggest": [
"Ausrüstungsgegenstand - Kostenerstattung für Kultur, Musik und Sport",
"Ausstattungsgegenstände - Kostenerstattung für Kultur, Musik und Sport",
"Teilnahme an Freizeiten (Pfadfinder)",
"Musikschule",
"Ausstattungsgegenstand - Kostenerstattung für Kultur, Musik und Sport",
"SGB XII, Grundsicherung, Sozialhilfe - Kostenerstattung für Kultur, Musik und Sport",
"Zuschüsse für Sportverein",
"Kostenerstattung für Kultur, Musik und Sport - Asylbewerberleistungsgesetz",
"Kostenerstattung für Kultur, Musik und Sport - Wohngeld",
"ALG II, SGB II, Hartz IV - Kostenerstattung für Kultur, Musik und Sport",
"Bildungspaket - Kostenerstattung für Kultur, Musik und Sport",
"Ausrüstungsgegenstände - Kostenerstattung für Kultur, Musik und Sport",
"Kindergeldzuschlag - Kostenerstattung für Kultur, Musik und Sport",
"Zuschuss zum Musikunterricht"
],
"synonyms": [
"Ausrüstungsgegenstand - Kostenerstattung für Kultur, Musik und Sport",
"Ausstattungsgegenstände - Kostenerstattung für Kultur, Musik und Sport",
"Teilnahme an Freizeiten (Pfadfinder)",
"Musikschule",
"Ausstattungsgegenstand - Kostenerstattung für Kultur, Musik und Sport",
"SGB XII, Grundsicherung, Sozialhilfe - Kostenerstattung für Kultur, Musik und Sport",
"Zuschüsse für Sportverein",
"Kostenerstattung für Kultur, Musik und Sport - Asylbewerberleistungsgesetz",
"Kostenerstattung für Kultur, Musik und Sport - Wohngeld",
"ALG II, SGB II, Hartz IV - Kostenerstattung für Kultur, Musik und Sport",
"Ausrüstungsgegenstände - Kostenerstattung für Kultur, Musik und Sport",
"Kindergeldzuschlag - Kostenerstattung für Kultur, Musik und Sport",
"Zuschuss zum Musikunterricht"
],
"timestamp": "2019-03-20T19:58:05.340299Z",
"validFrom": "2018-08-01",
"validTo": "2200-01-01"
},
{
"addressees": ["Bürger", "Unternehmen"],
"arsFederalstate": ["02"],
"description": "Private oder öffentliche Anbieter, Einzelpersonen oder Vereine, die geeignete Angebote in den Bereichen Kultur, Sport, Freizeit organisieren, können als Leistungsanbieter auftreten und sich bei der Stadt Hamburg registrieren lassen. Geeignete Angebote sind z. B. solche von , Fußballvereinen, Kirchengemeinden, die Freizeiten anbieten, Wohlfahrtsverbänden, Freie und staatliche Theater, Private Musiklehrer, gewerbliche Tanzschulen Gefördert werden bspw. Mitgliedsbeiträge in den Bereichen Sport, Spiel, Kultur und Geselligkeit, Unterricht in künstlerischen Fächern und vergleichbare angeleitete Aktivitäten der kulturellen Bildung (zum Beispiel Theaterworkshops). Nicht übernommen werden die Kosten für Eintrittskarten. Es gilt ein Maximalbetrag von zehn Euro monatlich. Ansparen für Freizeiten Für Freizeiten können die Monatsbeiträge für bis zu 12 Monate innerhalb eines Bewilligungszeitraums angespart werden (siehe hierzu auch Link 'Bildungspaket - Ansparen für Freizeiten'). Ausrüstungsgegenstände Alternativ können die 10 Euro monatlich auch zur Ausleihe oder zum Erwerb von Ausrüstungsgegenständen (z. B. Leihgebühr für ein Musikinstrument und Fußballschuhe) genutzt werden. Der jeweilige Ausrüstungsgegenstand muss allerdings in unmittelbarem Zusammenhang zu der Aktivität stehen, an der das Kind teilnimmt und darf nicht zum Alltagsbedarf gehören. Hierzu ist es notwendig, dass der Anbieter den tatsächlichen Bedarf auf dem Antragsformular des Kindes bestätigt und die anfallenden Kosten (Leihgebühren oder einmalige Anschaffungskosten) beziffert. Das Formular, mit dem Ausrüstungsgegenstände beantragt werden können, liegt in den Fachämtern für Grundsicherung und Soziales und in den Standorten der Jobcenter aus und wird in der Regel durch den Leistungsberechtigten selbst an die zentrale Abrechnungsstelle im Bezirksamt Eimsbüttel gesandt. Registrierung in der Leistungsanbieterdatenbank Für die Registrierung in der Leistungsanbieterdatenbank der Stadt Hamburg ist eine formlose E-Mail an das Funktionspostfach bildungspaket@basfi.hamburg.de zu senden. Die Organisation bzw. das Angebot sind kurz vorzustellen (Leistungsangebot, Art des Vereins, Zielgruppe). Auch ohne Nennung in der Liste kann man Leistungen abrechnen. Es ergeben sich keine verfahrenstechnischen Unterschiede.",
"id": "S100002LBS1000020010000006118",
"languageCode": "de-DE",
"name": "Bildungspaket - Informationen für Leistungsanbieter für die Bereiche Kultur, Musik und Sport",
"nameOtherDescription": "Bildungspaket - Informationen für Leistungsanbieter für die Bereiche Kultur, Musik und Sport",
"organisations": [
{
"ags": [],
"ars": ["020000000000"],
"organisationId": "S100002OES1000020020000000023"
}
],
"sourcePortal": {
"description": "Link zur Leistung im Ursprungsportal",
"link": {
"description": "Behördenfinder Hamburg",
"title": "Behördenfinder Hamburg",
"uri": "https://www.hamburg.de/behoerdenfinder/hamburg/d115/99107032000000"
},
"title": "Leistung im Ursprungsportal"
},
"specializations": [],
"suggest": [
"Ausrüstungsgegenstand, Informationen für Leistungsanbieter BuT",
"Ausstattungsgegenstände, Informationen für Leistungsanbieter BuT",
"Aufnahme in die zentrale Leistungsanbieterdatenbank",
"Ausstattungsgegenstand, Informationen für Leistungsanbieter BuT",
"Bildungspaket - Informationen für Leistungsanbieter für die Bereiche Kultur, Musik und Sport",
"Abrechnung Leistungen (Musik, Kultur, Sport)",
"Ausrüstungsgegenstände, Informationen für Leistungsanbieter BuT"
],
"synonyms": [
"Ausrüstungsgegenstand, Informationen für Leistungsanbieter BuT",
"Ausstattungsgegenstände, Informationen für Leistungsanbieter BuT",
"Aufnahme in die zentrale Leistungsanbieterdatenbank",
"Ausstattungsgegenstand, Informationen für Leistungsanbieter BuT",
"Abrechnung Leistungen (Musik, Kultur, Sport)",
"Ausrüstungsgegenstände, Informationen für Leistungsanbieter BuT"
],
"timestamp": "2019-03-20T19:58:04.947518Z",
"validFrom": "2018-08-01",
"validTo": "2200-01-01"
}
],
"empty": false,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 2,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 10,
"paged": true,
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"unpaged": false
},
"size": 10,
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"totalElements": 2,
"totalPages": 1
}

Methode /v2/servicedescriptions/{ars}/detail​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v2/servicedescriptions/{ars}/detail

Beschreibung​

Methode zum Abfragen von Detailinformationen (inklusive aller zuständigen Organisationseinheiten) für eine Verwaltungsleistung für ein Verwaltungsgebiet, definiert über die ARS-Angabe im Pfad.

Parameter​
NameBedeutungBeispiel
qID der angefragten Verwaltungsleistungq=S1000020010000006848
Beispiel​

https://mein.server.de/suchdienst/api/v2/servicedescriptions/020000000000/detail?q=S1000020010000006848 (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
{
"addressees": ["Bürger", "Unternehmen"],
"arsFederalstate": ["02"],
"description": "Das Landessportamtn nt, koordiniert die Umsetzung der Maßnahmen der Dekadenstrategie Sport und spezifiziert diese im Dialog mit denAkteuren des Sports, schafft und sichert die Rahmenbedingungen für den organisierten und nichtorganisierten Sport in Hamburgnt, hat als zentrale Aufgabe die staatliche Sportförderung in den Bereichen Breiten- und Leistungssport und Sportveranstaltungen, sowie die Fachaufsicht im Bereich Sportstätten und vertritt die gesamtstädtischen Interessen der Sportentwicklung in der Freien und Hansestand Hamburgnt, fungiert als zentraler Ansprechpartner für alle Partner des Sports und wirkt als Koordinator des Sports zwischen den Behördennt, ist für die Akquisition, Bewerbung, Begleitung und innerbehördliche Koordination von Sportveranstaltungen zuständignt, bündelt die Sportmarketingaktivitäten der Stadt und verwaltet die Marke Sportnt, begeistert Hamburgnt, vertritt die Interessen der Freien und Hansestadt Hamburg im Sport in regionalen, nationalen und internationalen Gremien undberät und unterstützt die Behördenleitung in sportfachlichen Angelegenheiten.nnnMit der Dekadenstrategie Sport wurde Anfang des Jahres 2012 durch den Senat der Freien und Hansestadt Hamburg ein Leitbild für die Entwicklung des Sports in Hamburg bis zum Jahr 2021 beschlossen.nnDas Landessportamt ist für die Koordinierung der Umsetzung zentraler Ansprechpartner.",
"details": [
{
"@type": "_module",
"additionalInformation": [],
"code": "02",
"links": [],
"replace": false,
"text": "Landessportamt",
"title": "Leistungsbezeichnung",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "03",
"links": [],
"replace": false,
"text": "Landessportamt",
"title": "Leistungsbezeichnung II (Leistungsname)",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "06",
"links": [],
"replace": false,
"text": "Das Landessportamtn nt, koordiniert die Umsetzung der Maßnahmen der Dekadenstrategie Sport und spezifiziert diese im Dialog mit denAkteuren des Sports, schafft und sichert die Rahmenbedingungen für den organisierten und nichtorganisierten Sport in Hamburgnt, hat als zentrale Aufgabe die staatliche Sportförderung in den Bereichen Breiten- und Leistungssport und Sportveranstaltungen, sowie die Fachaufsicht im Bereich Sportstätten und vertritt die gesamtstädtischen Interessen der Sportentwicklung in der Freien und Hansestand Hamburgnt, fungiert als zentraler Ansprechpartner für alle Partner des Sports und wirkt als Koordinator des Sports zwischen den Behördennt, ist für die Akquisition, Bewerbung, Begleitung und innerbehördliche Koordination von Sportveranstaltungen zuständignt, bündelt die Sportmarketingaktivitäten der Stadt und verwaltet die Marke Sportnt, begeistert Hamburgnt, vertritt die Interessen der Freien und Hansestadt Hamburg im Sport in regionalen, nationalen und internationalen Gremien undberät und unterstützt die Behördenleitung in sportfachlichen Angelegenheiten.nnnMit der Dekadenstrategie Sport wurde Anfang des Jahres 2012 durch den Senat der Freien und Hansestadt Hamburg ein Leitbild für die Entwicklung des Sports in Hamburg bis zum Jahr 2021 beschlossen.nnDas Landessportamt ist für die Koordinierung der Umsetzung zentraler Ansprechpartner.",
"title": "Volltext",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "08",
"links": [],
"replace": false,
"text": "Dokumente zur Dekadenstrategie und zur Sportförderung siehe:<br />nhttps://www.hamburg.de/innenbehoerde/sportamt/",
"title": "Erforderliche Unterlagen",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "16",
"links": [],
"replace": false,
"text": "Zentrale Ansprechpartner ist die Geschäftsstelle des Landessportamts, Telefon: 040 / 428 24-351<br />nEmail-Funktionspostfach: poststelle&#64;sportamt.hamburg.de",
"title": "Hinweise (Besonderheiten)",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "18",
"links": [
{
"description": "Behördenfinder Hamburg",
"title": "Behördenfinder Hamburg",
"uri": "https://www.hamburg.de/behoerdenfinder"
}
],
"replace": false,
"text": "Link zur Leistung im Ursprungsportal",
"title": "Urheber",
"xZufiCategory": "TEXT_MODUL"
},
{
"@type": "_module",
"additionalInformation": [],
"code": "0",
"links": [
{
"description": "Belegungsplan Sportstätten online",
"title": "Belegungsplan Sportstätten online",
"uri": "https://afm.hamburg.de/intelliform/forms/spo_sportstaettenbelegung/standard/spo_sportstaettenbelegung/index"
}
],
"replace": false,
"text": "-",
"title": "Link bzw. URL zum Online-Dienst",
"xZufiCategory": "TEXT_MODUL_INDIVIDUELL"
}
],
"id": "S100002LBS1000020010000006848",
"languageCode": "de-DE",
"name": "Landessportamt",
"nameOtherDescription": "Landessportamt",
"onlineServiceLink": {
"description": "Belegungsplan Sportstätten online",
"title": "Belegungsplan Sportstätten online",
"uri": "https://afm.hamburg.de/intelliform/forms/spo_sportstaettenbelegung/standard/spo_sport staettenbelegung/index"
},
"organisations": [
{
"ags": [],
"ars": ["020000000000"],
"organisationId": "S100002OES1000020020000013990"
}
],
"sourcePortal": {
"description": "Link zur Leistung im Ursprungsportal",
"link": {
"description": "Behördenfinder Hamburg",
"title": "Behördenfinder Hamburg",
"uri": "https://www.hamburg.de/behoerdenfinder"
},
"title": "Leistung im Ursprungsportal"
},
"specializations": [],
"suggest": [
"Breitensport Förderung",
"Sportverein Förderung",
"Sportamt Hamburg",
"Spitzensport Förderung",
"Landessportamt",
"Sportveranstaltung",
"Sportförderung"
],
"synonyms": [
"Breitensport Förderung",
"Sportverein Förderung",
"Sportamt Hamburg",
"Spitzensport Förderung",
"Sportveranstaltung",
"Sportförderung"
],
"timestamp": "2019-03-20T19:58:16.012337Z",
"validFrom": "2018-08-01",
"validTo": "2200-01-01"
}

Methode /v1/servicedescriptions/{ars}/jzufi​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v1/servicedescriptions/{ars}/jzufi

Beschreibung​

Methode zum Abfragen von Detailinformationen in Form von JZuFi (=XZuFI in JSON-Format) für eine Verwaltungsleistung für ein Verwaltungsgebiet, definiert über die ARS-Angabe im Pfad.

Parameter​
NameBedeutungBeispiel
qID der angefragten Verwaltungsleistungq=S1000020010000006848
Beispiel​

https://mein.server.de/suchdienst/api/v1/servicedescriptions/020000000000/jzufi?q=S1000020010000006848 (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
{
"gueltigkeit": [
{
"beginn": "2018-08-01",
"ende": "2200-01-01"
}
],
"herausgeber": {
"bezeichnung": ["Finanzbehörde Hamburg"],
"id": {
"value": "FHH_FB"
},
"kurzbezeichnung": ["Finanzbehörde Hamburg"]
},
"id": {
"schemeAgencyID": "S100002",
"value": "S1000020010000006848"
},
"idSekundaer": [
{
"schemeAgencyID": "XZUFI_ERWEITERUNG",
"schemeID": "OPERATION_SCHLUESSEL",
"value": "CreateUpdate"
},
{
"schemeAgencyID": "XZUFI_ERWEITERUNG",
"schemeID": "LEIKA_SCHLUESSEL",
"schemeVersionID": "20180102",
"value": "99098004027000"
}
],
"leistungsadressat": [
{
"code": "001",
"listURI": "urn:de:xzufi:codeliste:leistungsadressat",
"listVersionID": "1.0"
},
{
"code": "002",
"listURI": "urn:de:xzufi:codeliste:leistungsadressat",
"listVersionID": "1.0"
}
],
"modulBegriffImKontext": [
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Breitensport Förderung"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 1
},
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Spitzensport Förderung"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 2
},
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Sportamt Hamburg"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 3
},
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Sportförderung"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 4
},
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Sportveranstaltung"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 5
},
{
"begriffImKontext": [
{
"begriff": {
"languageCode": "de-DE",
"value": "Sportverein Förderung"
},
"typ": {
"code": "001",
"listURI": "urn:de:xzufi:codeliste:begriffimkontexttyp",
"listVersionID": "1.0"
}
}
],
"positionDarstellung": 6
}
],
"modulText": [
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Landessportamt"
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "02",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 1,
"weiterfuehrenderLink": []
},
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Landessportamt"
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "03",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 2,
"weiterfuehrenderLink": []
},
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Das Landessportamtn nt, koordiniert die Umsetzung der Ma&szlig;nahmen der Dekadenstrategie Sport und spezifiziert diese im Dialog mit denAkteuren des Sports, schafft und sichert die Rahmenbedingungen f&uuml;r den organisierten und nichtorganisierten Sport in Hamburgnt, hat als zentrale Aufgabe die staatliche Sportf&ouml;rderung in den Bereichen Breiten- und Leistungssport und Sportveranstaltungen, sowie die Fachaufsicht im Bereich Sportst&auml;tten und vertritt die gesamtst&auml;dtischen Interessen der Sportentwicklung in der Freien und Hansestand Hamburgnt, fungiert als zentraler Ansprechpartner f&uuml;r alle Partner des Sports und wirkt als Koordinator des Sports zwischen den Beh&ouml;rdennt, ist f&uuml;r die Akquisition, Bewerbung, Begleitung und innerbeh&ouml;rdliche Koordination von Sportveranstaltungen zust&auml;ndignt, b&uuml;ndelt die Sportmarketingaktivit&auml;ten der Stadt und verwaltet die Marke Sportnt, begeistert Hamburgnt, vertritt die Interessen der Freien und Hansestadt Hamburg im Sport in regionalen, nationalen und internationalen Gremien undber&auml;t und unterst&uuml;tzt die Beh&ouml;rdenleitung in sportfachlichen Angelegenheiten.nnnMit der Dekadenstrategie Sport wurde Anfang des Jahres 2012 durch den Senat der Freien und Hansestadt Hamburg ein Leitbild f&uuml;r die Entwicklung des Sports in Hamburg bis zum Jahr 2021 beschlossen.nnDas Landessportamt ist f&uuml;r die Koordinierung der Umsetzung zentraler Ansprechpartner."
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "06",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 3,
"weiterfuehrenderLink": []
},
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Dokumente zur Dekadenstrategie und zur Sportf&ouml;rderung siehe:<br />nhttps://www.hamburg.de/innenbehoerde/sportamt/"
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "08",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 4,
"weiterfuehrenderLink": []
},
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Zentrale Ansprechpartner ist die Gesch&auml;ftsstelle des Landessportamts, Telefon: 040 / 428 24-351<br />nEmail-Funktionspostfach: poststelle@sportamt.hamburg.de"
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "16",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 5,
"weiterfuehrenderLink": []
},
{
"inhalt": [
{
"languageCode": "de-DE",
"value": "Link zur Leistung im Ursprungsportal"
}
],
"leikaTextModulAbweichendeBezeichnung": [],
"leikaTextmodul": {
"code": "18",
"listURI": "urn:de:xzufi:codeliste:leistungstextmodulleika",
"listVersionID": "20150601"
},
"positionDarstellung": 6,
"weiterfuehrenderLink": [
{
"beschreibung": "Behördenfinder Hamburg",
"languageCode": "de-DE",
"positionDarstellung": 1,
"titel": "Behördenfinder Hamburg",
"uri": "https://www.hamburg.de/behoerdenfinder"
}
]
}
],
"modulTextIndividuell": [
{
"id": {
"value": "LINK_URL_ONLINE_DIENST"
},
"individuellesTextmodultyp": {
"bezeichnung": [
{
"languageCode": "de-DE",
"value": "Link bzw. URL zum Online-Dienst"
}
],
"hinweis": []
},
"inhalt": [],
"weiterfuehrenderLink": [
{
"beschreibung": "Belegungsplan Sportstätten online",
"positionDarstellung": 115,
"titel": "Belegungsplan Sportstätten online",
"uri": "https://afm.hamburg.de/intelliform/forms/spo_sportstaettenbelegung/standard/spo_sportstaettenbelegung/index"
}
]
}
],
"spezialisierung": [],
"sprachversion": [
{
"geaendertDatumZeit": "2019-03-07T21:45:04Z",
"languageCode": "de-DE",
"sprachbezeichnungDeutsch": "Deutsch",
"sprachbezeichnungNativ": "Deutsch"
}
],
"versionsinformation": {
"geaendertDatumZeit": "2019-03-07T21:45:04Z",
"geaendertDurch": "Finanzbehörde Hamburg"
}
}

Methode /v1/organisationunits/detail​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
Pfad​

/v1/organisationunits/detail

Beschreibung​

Methode zum Abfragen von Detailinformationen einer Organisationseinheit.

Parameter​
NameBedeutungBeispiel
qID der angefragten Organisationseinheitq=1000020020000011615
Beispiel​

https://mein.server.de/suchdienst/api/v1/organisationunits/detail?q=S1000020020000011615 (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
{
"title": "Stadtreinigung Hamburg",
"description": "Organisation: Externe, Behörde: Stadtreinigung Hamburg, Amt: Stadtreinigung Hamburg",
"shortDescription": "Organisation: Externe, Behörde: Stadtreinigung Hamburg, Amt: Stadtreinigung Hamburg",
"mapUrl": null,
"location": {
"title": null,
"urls": [],
"information": [],
"addresses": [
{
"code": "001",
"city": "Hamburg",
"houseNumber": "19",
"type": "Hausanschrift",
"zip": "20537",
"street": "Bullerdeich",
"postbox": ""
}
],
"communications": [
{
"code": "telefon",
"name": "Telefon",
"value": "+49 40 2576 13 13"
},
{
"code": "email",
"name": "E-Mail",
"value": "info@srhh.de"
},
{
"code": "fax",
"name": "Telefax",
"value": "+49 40 25761110"
},
{
"code": "demail",
"name": "De-Mail",
"value": "onlinedienste@hamburg.de-mail.de"
}
]
},
"employees": [],
"forms": [
{
"uri": "https://www.hamburg.de/behoerden",
"title": "Webseite der zuständigen Stelle",
"description": "Webseite der zuständigen Stelle"
},
{
"uri": "https://www.hamburg.de/Dibis/bilder/hh/hh0042.jpg",
"title": "Bild Bullerdeich 19",
"description": "Bild Bullerdeich 19"
}
],
"additionalInformation": [
{
"title": "Parkplatz",
"text": "",
"additionalInformation": []
},
{
"title": "Barrierefreiheit",
"text": "",
"additionalInformation": []
},
{
"title": "Öffentlicher Personennahverkehr",
"text": "Busse 25/112/154/160 Ausschläger Weg (Verkehrsamt)",
"additionalInformation": []
},
{
"title": "Sonstige Informationen",
"text": "",
"additionalInformation": []
}
],
"bankAccounts": []
}

Methode /v2/organisationunits/jzufi​

Nachrichtenformat Abfrage​

Übersicht möglicher Eingabeparameter
NameBedeutungBeispiel
acceptStandard-HTTP-Header mit Angabe einer XZuFi-VersionAccept:application/json;xzufiversion=2.3.1
Parameter​
NameBedeutungBeispiel
idID der angefragten Organisationseinheitid=1000020020000011615
validdateGültigkeitsdatum in der Form yyyy-MM-ddvaliddate=2023-12-31
Beispiel​

https://mein.server.de/suchdienst/api/v2/organisationunits/jzufi?id=S1000020020000011615 (öffnet in neuem Tab)

Nachrichtenformat Ergebnis​

Beispielhaftes Ergebnis der Anfrage (Request)
{
"kontaktperson": [
{
"id": {
"value": "249249733_249249740",
"schemeAgencyID": "L100012",
"schemeAgencyName": "TSA Public Service GmbH",
"schemeID": "TSA_ZUFISH_OID",
"schemeName": "Zuständigkeitsfinder Schleswig-Holstein ObjektID"
},
"anrede": [
{
"value": "Frau",
"languageCode": "de"
}
],
"familienname": "XXXXXXXX",
"position": [
{
"value": "Department III - Citizens' and Social Office",
"languageCode": "en"
},
{
"value": "Sachgebiet III - Bürger- und Sozialbüro",
"languageCode": "de"
}
],
"raum": "Etage: EG | Raum: 1",
"anschrift": [
{
"typ": {
"code": "001",
"listURI": "urn:xoev-de:fim:codeliste:xzufi.anschrifttyp",
"listVersionID": "4"
},
"strasse": "Am Markt",
"hausnummer": "1",
"postleitzahl": "24782",
"ort": "Büdelsdorf",
"ortID": [
{
"value": "010580034034",
"schemeID": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs",
"schemeVersionID": "2022-09-30"
}
],
"verwaltungspolitischeKodierung": {
"staat": {
"code": "000",
"name": "Deutschland",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:staat",
"listVersionID": "2022-02-18"
},
"bundesland": {
"code": "01",
"name": "Schleswig-Holstein",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:bundesland",
"listVersionID": "2010-04-01"
},
"kreis": {
"code": "01058",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:kreis",
"listVersionID": "2021-07-31"
},
"gemeindeschluessel": {
"code": "01058034",
"name": "Büdelsdorf",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:ags",
"listVersionID": "2022-09-30"
},
"regionalschluessel": {
"code": "010580034034",
"name": "Büdelsdorf",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs",
"listVersionID": "2022-09-30"
}
}
}
],
"erreichbarkeit": [
{
"kanal": {
"code": "01",
"listURI": "urn:de:xoev:codeliste:erreichbarkeit",
"listVersionID": "4.1"
},
"kennung": "XXXXX@buedelsdorf.de"
}
],
"zustaendigkeit": [
{
"leistungID": [
{
"value": "8966900",
"schemeAgencyID": "L100012",
"schemeAgencyName": "TSA Public Service GmbH",
"schemeID": "TSA_ZUFISH_OID",
"schemeName": "Zuständigkeitsfinder Schleswig-Holstein ObjektID"
},
"... // gekürzt für die Übersicht"
],
"gebietID": [
{
"value": "010580034034",
"schemeID": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs",
"schemeVersionID": "2022-09-30"
}
]
}
],
"kennzeichenOeffentlichAnzeigen": true
},
"... // gekürzt für die Übersicht"
],
"id": {
"value": "249249740",
"schemeAgencyID": "L100012",
"schemeAgencyName": "TSA Public Service GmbH",
"schemeID": "TSA_ZUFISH_OID",
"schemeName": "Zuständigkeitsfinder Schleswig-Holstein ObjektID"
},
"externeOrganisationseinheitsermittlung": false,
"name": [
{
"name": [
{
"value": "Stadt Büdelsdorf - Bürgerservice und Ordnung",
"languageCode": "de"
}
]
}
],
"infoOeffnungszeitenText": [
{
"value": " Mo. bis Fr. 8.00 bis 12.00 Uhr \nDo. 15.00 bis 17.30 Uhr \noder nach Vereinbarung ",
"html": true,
"languageCode": "de"
},
{
"value": " Mon. to Fri. 8.00 a.m. to 12.00 p.m. \nThurs. 15.00 to 17.30 \nor by appointment ",
"html": true,
"languageCode": "en"
},
"... // gekürzt für die Übersicht"
],
"anschrift": [
{
"typ": {
"code": "001",
"listURI": "urn:xoev-de:fim:codeliste:xzufi.anschrifttyp",
"listVersionID": "4"
},
"strasse": "Am Markt",
"hausnummer": "1",
"postleitzahl": "24782",
"ort": "Büdelsdorf",
"ortID": [
{
"value": "010580034034",
"schemeID": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs",
"schemeVersionID": "2022-09-30"
}
],
"verwaltungspolitischeKodierung": {
"staat": {
"code": "000",
"name": "Deutschland",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:staat",
"listVersionID": "2022-02-18"
},
"bundesland": {
"code": "01",
"name": "Schleswig-Holstein",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:bundesland",
"listVersionID": "2010-04-01"
},
"kreis": {
"code": "01058",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:kreis",
"listVersionID": "2021-07-31"
},
"gemeindeschluessel": {
"code": "01058034",
"name": "Büdelsdorf",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:ags",
"listVersionID": "2022-09-30"
},
"regionalschluessel": {
"code": "010580034034",
"name": "Büdelsdorf",
"listURI": "urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs",
"listVersionID": "2022-09-30"
}
}
}
],
"erreichbarkeit": [
{
"kanal": {
"code": "02",
"listURI": "urn:de:xoev:codeliste:erreichbarkeit",
"listVersionID": "4.1"
},
"kennung": "+49 4331 XXXXX"
},
{
"kanal": {
"code": "01",
"listURI": "urn:de:xoev:codeliste:erreichbarkeit",
"listVersionID": "4.1"
},
"kennung": "XXXXX@buedelsdorf.de"
}
],
"kennzeichenOeffentlichAnzeigen": true,
"versionsinformation": {
"erstelltDatumZeit": "2019-06-14T13:55:25+02:00",
"geaendertDatumZeit": "2025-08-01T14:02:54.904+02:00"
},
"sprachversion": [
{
"kennzeichenMaschinelleUebersetzung": false,
"erstelltDatumZeit": "2017-06-07T06:09:26+02:00",
"geaendertDatumZeit": "2025-05-14T09:20:47+02:00",
"languageCode": "de",
"sprachbezeichnungDeutsch": "Deutsch",
"sprachbezeichnungNativ": "Deutsch"
},
{
"kennzeichenMaschinelleUebersetzung": false,
"erstelltDatumZeit": "2021-07-08T14:17:43+02:00",
"geaendertDatumZeit": "2020-10-30T13:08:34+01:00",
"languageCode": "en",
"sprachbezeichnungDeutsch": "Englisch",
"sprachbezeichnungNativ": "English"
}
]
}