{"openapi":"3.0.3","info":{"title":"TSA Infodienste - ID REST ZUFI V4","description":"Dies ist die Dokumentation der RestApi der 'TSA Infodienste REST API - Zuständigkeitsfinder'. Der Zugriff auf die RestApi ist über einen ApiKey geschützt, dieser wird im Redaktionssystem der Infodienste konfiguriert.","version":"4.10.003","contact":{"name":"TSA - Infodienste","url":"http://infodienste.de"}},"security":[{"api_key":["*"]}],"tags":[{"name":"Allgemein","description":"Allgemeine Resourcen wie Typen, Sprachen, Zahlungsarten, etc."},{"name":"Leistung","description":"Methoden für Leistungen"},{"name":"Organisationseinheit","description":"Methoden für Organisationseinheiten"},{"name":"Person","description":"Methoden für Personen"}],"paths":{"/types/address":{"get":{"tags":["Allgemein"],"description":"Gibt alle Adresstypen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/communication":{"get":{"tags":["Allgemein"],"description":"Gibt alle Kommunikationstypen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/textBlock":{"get":{"tags":["Allgemein"],"description":"Gibt alle Typen für Textblöcke zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/parkingLot":{"get":{"tags":["Allgemein"],"description":"Gibt alle Parkplatztypen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/publicTransportationLine":{"get":{"tags":["Allgemein"],"description":"Gibt alle Verkehrsmittel-Typen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/paymentMethod":{"get":{"tags":["Allgemein"],"description":"Gibt alle Zahlungsarten zurück (Kosten bei Leistungen).","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/contact":{"get":{"tags":["Allgemein"],"description":"Gibt alle Kontaktsystem-Typen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/types/competence":{"get":{"tags":["Allgemein"],"description":"Gibt alle Zuständigkeitskriterium-Typen zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Type"}}}}},"404":{"description":"class not found"}}}},"/common/onlineApplicationLink":{"get":{"tags":["Allgemein"],"description":"Gibt die Links zur elektronischen Antragstellung zurück.","parameters":[{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamAreaId"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockExternalLink"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockExternalLink"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockExternalLink"}}}}}}}},"/common/portalLink":{"get":{"tags":["Allgemein"],"description":"Gibt den Link zum Portal zurück.","parameters":[{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamOrganisationalUnitId"},{"$ref":"#/components/parameters/GetParamFormId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeCategoryId"}],"responses":{"200":{"description":"successful operation","content":{"text/plain":{"schema":{"type":"string","example":"http://xxxxxxx.yyyyyyy.zz"}}}},"404":{"description":"object not found"}}}},"/common/languages":{"get":{"tags":["Allgemein"],"description":"Gibt alle Sprachen zurück.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}}}}}}},"/common/oustructure":{"get":{"tags":["Allgemein"],"description":"Gibt alle, zusätzlich zur normalen Struktur, definiereten Hierarchien von Organisationseinheiten zurück.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}}}}}}}},"/common/oustructure/{id}":{"get":{"tags":["Allgemein"],"description":"Gibt eine, zusätzlich zur normalen Struktur, definierete Hierarchie für Organisationseinheiten zurück","parameters":[{"name":"id","in":"path","description":"Id des Struktur/Hierarchie.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}}}},"404":{"description":"group not found"}}}},"/common/ousynonym":{"get":{"tags":["Allgemein"],"description":"Gibt alle zentral gepflegten Synonyme für Organisationseinheiten zurück. Diese werden an Organisationseinheiten verwendet, jedoch nicht referenziert.","parameters":[{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitSynonym"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitSynonym"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitSynonym"}}}}}}}},"/directoryPerson/findAll":{"get":{"tags":["Allgemein"],"description":"Gibt Personen aus dem Mitarbeiterverzeichnis zurück.","parameters":[{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryPersonResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DirectoryPersonResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DirectoryPersonResult"}}}}}}},"/paymentProvider/{id}":{"get":{"tags":["Allgemein"],"description":"Ermittelt einen Zahlungsdienst anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id des Zahlungsdienstleister.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentProvider"}}}},"404":{"description":"group not found"}}}},"/paymentProvider/find":{"get":{"tags":["Allgemein"],"description":"Benutzen Sie diese Funktion um Zahlungsdienste zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProviderResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PaymentProviderResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentProviderResult"}}}}}}},"/department/{id}":{"get":{"tags":["Allgemein"],"description":"Ermittelt ein Ressort der Id.","parameters":[{"name":"id","in":"path","description":"Id des Ressort.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Department"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Department"}}}},"404":{"description":"group not found"}}}},"/department/find":{"get":{"tags":["Allgemein"],"description":"Benutzen Sie diese Funktion um Ressorts zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/DepartmentResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DepartmentResult"}}}}}}},"/pst/{id}":{"get":{"tags":["Leistung"],"description":"Ermittelt eine Leistung anhand der Id.","parameters":[{"name":"id","in":"path","description":"Id der Leistung.","required":true,"schema":{"type":"string","format":"token"}},{"name":"areaId","in":"query","description":"Id des Gebietes wofür die Leistung spezialisiert werden soll.","required":false,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceType"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceType"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceType"}}}},"404":{"description":"publicservicetype not found"}}}},"/pst/byLeikaKey/{leikaKey}":{"get":{"tags":["Leistung"],"description":"Ermittelt Leistungen anhand des Leika-Schlüssels.","parameters":[{"name":"leikaKey","in":"path","description":"LeikaSchlüssel der Leistung.","required":true,"schema":{"type":"string","pattern":"^99\\d{12}$"}},{"name":"areaId","in":"query","description":"Id des Gebietes wofür die Leistungen spezialisiert werden sollen.","required":false,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}}}}}}},"/pst/findByIds":{"get":{"tags":["Leistung"],"description":"Ermittelt Leistungen anhand der Ids.","parameters":[{"name":"id","in":"query","description":"Id der Leistung.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"areaId","in":"query","description":"Id des Gebietes wofür die Leistung spezialisiert werden soll.","required":false,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}}}},"404":{"description":"publicservicetype not found"}}}},"/pst/find":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um Leistungen zu finden. Folgende Parameter werden bei Suchen in externen Systemen nicht beachtet: pstCatId, pstGroupId, ecoSecCode, legalFormId, nationalityId, participantId, filterTextBlockTypes. INFO: Es werden keine Sonderzeichen, außer Leerzeichen, unterstützt.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamHasCompetence"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeCategoryIdArray"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeGroupId"},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamFilterTextBlockTypes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}}}}}}},"/pst/findAll":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um alle Leistungen zu finden. Dabei werden immer alle gebietseingeschränkten Leistungen mit zurück gegeben.","parameters":[{"name":"areaRS","in":"query","description":"Zweistelliger Bundsland-Regionalschlüssel für das die Abfrage gilt. Wenn leer, dann eigenes Bundesland der RestApi.","required":false,"schema":{"type":"string","pattern":"^[0-9]{2}$"}},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamFilterTextBlockTypes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}}}}}}},"/pst/assignedLeikaKeys":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um alle verwendeten Leika-Schlüssel zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","maxLength":14,"example":"99005004114000"},"description":"Leikaschlüssel"}},"text/xml":{"schema":{"type":"array","items":{"type":"string","maxLength":14,"example":"99005004114000"},"description":"Leikaschlüssel"}},"application/xml":{"schema":{"type":"array","items":{"type":"string","maxLength":14,"example":"99005004114000"},"description":"Leikaschlüssel"}}}}}}},"/pst/startsWith":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um Leistungen anhand von Anfangsbuchstaben zu finden, mit denen der Leistungsname beginnt.","parameters":[{"name":"startsWith","in":"query","description":"Beginn des Leistungsnamen","required":true,"schema":{"type":"array","items":{"type":"string","maxLength":1}}},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeCategoryIdArray"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeGroupId"},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamFilterTextBlockTypes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeResult"}}}}}}},"/pstCategory/{id}":{"get":{"tags":["Leistung"],"description":"Ermittelt eine Leistungskategorie anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id der Leistungskategorie.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategory"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategory"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategory"}}}},"404":{"description":"category not found"}}}},"/pstCategory/find":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um Leistungskategorien zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamParentId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeGroupId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategoryResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategoryResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeCategoryResult"}}}}}}},"/pstProcess/{id}":{"get":{"tags":["Leistung"],"description":"Ermittelt einen Process einer Leistung anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id des Processes.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcess"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcess"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcess"}}}},"404":{"description":"process not found"}}}},"/pstProcess/find":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um Process von Leistungen zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcessResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcessResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeProcessResult"}}}}}}},"/pstGroup/{id}":{"get":{"tags":["Leistung"],"description":"Ermittelt eine Leistungsgruppe anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id der Leistungsgruppe.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroup"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroup"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroup"}}}},"404":{"description":"group not found"}}}},"/pstGroup/find":{"get":{"tags":["Leistung"],"description":"Benutzen Sie diese Funktion um Leistungsgruppen zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroupResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroupResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PublicServiceTypeGroupResult"}}}}}}},"/os/{id}/help":{"get":{"tags":["Onlinedienst"],"description":"Ermittelt, falls vorhanden, den Hilfelink und Hilfetext. ","parameters":[{"name":"id","in":"path","description":"Id des Onlinedienstes.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceHelp"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceHelp"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceHelp"}}}},"404":{"description":"onlineservice not found"}}}},"/os/{id}":{"get":{"tags":["Onlinedienst"],"description":"Ermittelt einen Onlinedienst anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id des Onlinedienstes.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineService"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineService"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineService"}}}},"404":{"description":"onlineservice not found"}}}},"/os/find":{"get":{"tags":["Onlinedienst"],"description":"Benutzen Sie diese Funktion um Onlinedienste anhand von Suchbegriffen zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamOnlineServiceGroupId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}}}}}}},"/os/findByIds":{"get":{"tags":["Onlinedienst"],"description":"Ermittelt Onlinedienste anhand der Ids.","parameters":[{"name":"id","in":"query","description":"Id des Onlinedienstes.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}}}},"404":{"description":"publicservicetype not found"}}}},"/os/findByCompetence":{"get":{"tags":["Onlinedienst"],"description":"Benutzen Sie diese Funktion um Onlinedienste anhand ihrer Zuständigkeit für eine Gebiet zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"name":"areaId","in":"query","description":"Id des Gebietes wofür die Onlinedienste zuständig sind.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceResult"}}}}}}},"/osCompetence/find":{"get":{"tags":["Onlinedienst"],"description":"Benutzen Sie diese Funktion um alle Zuständigkeiten von Onlinediensten zu ermitteln.","parameters":[{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}}}}}}},"/osCompetence/{id}":{"get":{"tags":["Onlinedienst"],"description":"Benutzen Sie diese Funktion um die Zuständigkeiten eines Onlinedienstes zu ermitteln.","parameters":[{"name":"id","in":"path","description":"Id des Onlinedienstes.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceCompetenceResult"}}}}}}},"/osGroup/{id}":{"get":{"tags":["Onlinedienst"],"description":"Ermittelt eine Onlinedienstgruppe anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id der Onlinedienstgruppe.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroup"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroup"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroup"}}}},"404":{"description":"group not found"}}}},"/osGroup/find":{"get":{"tags":["Onlinedienst"],"description":"Benutzen Sie diese Funktion um Gruppen von Onlinediensten zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroupResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroupResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OnlineServiceGroupResult"}}}}}}},"/ou/{id}":{"get":{"tags":["Organisationseinheit"],"description":"Ermittelt eine Organisationseinheit anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnit"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnit"}}}},"404":{"description":"organisational unit not found"}}}},"/ou/{id}/addressEfaLinks":{"get":{"tags":["Organisationseinheit"],"description":"Generiert den zur ID passenden Efa-Link der Adressen.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EfaLink"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EfaLink"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EfaLink"}}}}}}}},"/ou/{id}/publicTransportationStopEfaLinks":{"get":{"tags":["Organisationseinheit"],"description":"Generiert den zur ID passenden Efa-Link der Haltestellen.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"https://xxxxxx","description":"Efa-Links für Haltestellen"}}},"text/xml":{"schema":{"type":"array","items":{"type":"string","example":"https://xxxxxx","description":"Efa-Links für Haltestellen"}}},"application/xml":{"schema":{"type":"array","items":{"type":"string","example":"https://xxxxxx","description":"Efa-Links für Haltestellen"}}}}}}}},"/ou/{id}/externalCompetenceDetection":{"get":{"tags":["Organisationseinheit"],"description":"Es wird ausgegeben ob eine externe Organisationsermittlung verfügbar ist oder nicht.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"boolean","example":"true / false","description":"Boolean ob externe Ermittlung vorhanden ist oder nicht."}},"text/xml":{"schema":{"type":"boolean","example":"true / false","description":"Boolean ob externe Ermittlung vorhanden ist oder nicht."}},"application/xml":{"schema":{"type":"boolean","example":"true / false","description":"Boolean ob externe Ermittlung vorhanden ist oder nicht."}}}}}}},"/ou/find":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um Organisationseinheiten anhand von Suchbegriffen zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamParentId"},{"$ref":"#/components/parameters/GetParamOrganisationalUnitCategoryIdArray"},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}}}}}}},"/ou/findByIds":{"get":{"tags":["Organisationseinheit"],"description":"Ermittelt Organisationseinheiten anhand der Ids.","parameters":[{"name":"id","in":"query","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}}}},"404":{"description":"publicservicetype not found"}}}},"/ou/findByStructure":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um Organisationseinheiten anhand der OU-Baumhierarchie-Id oder einer der Blätter der Baumhierarchie zu finden.","parameters":[{"$ref":"#/components/parameters/GetOuStructureId"},{"$ref":"#/components/parameters/GetOuStructureNodeId"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"name":"startsWith","in":"query","description":"Erster Buchstabe vom Namen der Organisationseinheit.","required":false,"schema":{"type":"array","items":{"type":"string","maxLength":1}}},{"$ref":"#/components/parameters/HeaderParamLanguage"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamSortAttributes"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}}}}}}},"/ou/findByArea":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um Organisationseinheiten an einem bestimmten Standort zu finden. Es werden die Orte an Adressen durchsucht.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"name":"areaId","in":"query","description":"Id des Gebietes des Ortes in der Adresse der Organisationseinheiten.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}}}}}}},"/ou/findByCompetence":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um Organisationseinheiten anhand ihrer Zuständigkeit für eine Gebiet zu finden. Folgende Parameter werden bei der Suche in externen Quellen nicht verwendet: participantId","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"name":"areaId","in":"query","description":"Id des Gebietes wofür die Organisationseinheiten zuständig sind.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitResult"}}}}}}},"/ouCategory/{id}":{"get":{"tags":["Organisationseinheit"],"description":"Ermittelt eine Organisationseinheitkategorie anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheitkategorie.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategory"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategory"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategory"}}}},"404":{"description":"category not found"}}}},"/ouCategory/find":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um Organisationseinheitkategorien zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamParentId"},{"$ref":"#/components/parameters/GetParamOrganisationalUnitId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategoryResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategoryResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrganisationalUnitCategoryResult"}}}}}}},"/ouCompetence/{id}":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um die Zuständigkeiten einer Organisationseinheit zu ermitteln.","parameters":[{"name":"id","in":"path","description":"Id der Organisationseinheit.","required":true,"schema":{"type":"string","format":"token"}},{"name":"subOrganisationalUnits","in":"query","description":"Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}}}}}}},"/ouCompetence/find":{"get":{"tags":["Organisationseinheit"],"description":"Benutzen Sie diese Funktion um alle Zuständigkeiten von Organisationseinheiten zu ermitteln.","parameters":[{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamLeikaKey"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OuCompetenceResult"}}}}}}},"/person/{id}":{"get":{"tags":["Person"],"description":"Ermittelt eine Person anhand ihrer Id.","parameters":[{"name":"id","in":"path","description":"Id der Person.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Person"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Person"}}}},"404":{"description":"person not found"}}}},"/person/find":{"get":{"tags":["Person"],"description":"Benutzen Sie diese Funktion um Personen zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamAreaId"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamOrganisationalUnitId"},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"name":"subOrganisationalUnits","in":"query","description":"Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PersonResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PersonResult"}}}}}}},"/form/{id}":{"get":{"tags":["Form"],"description":"Ermittelt ein Formular anhand seiner Id.","parameters":[{"name":"id","in":"path","description":"Id des Formulars.","required":true,"schema":{"type":"string","format":"token"}},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Form"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Form"}}}},"404":{"description":"form not found"}}}},"/form/find":{"get":{"tags":["Form"],"description":"Benutzen Sie diese Funktion um Formulare zu finden.","parameters":[{"$ref":"#/components/parameters/GetParamSearchWord"},{"$ref":"#/components/parameters/GetParamSearchFullText"},{"$ref":"#/components/parameters/GetParamSearchFuzzy"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeId"},{"$ref":"#/components/parameters/GetParamOrganisationalUnitId"},{"name":"subOrganisationalUnits","in":"query","description":"Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs","required":false,"schema":{"type":"boolean"}},{"name":"includeLocalForms","in":"query","description":"Lokale Formulare auch ermitteln. Default: False","required":true,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GetParamParticipantId"},{"$ref":"#/components/parameters/GetParamOffset"},{"$ref":"#/components/parameters/GetParamLimit"},{"$ref":"#/components/parameters/GetParamAttributes"},{"$ref":"#/components/parameters/GetParamSortAttributes"},{"$ref":"#/components/parameters/HeaderParamLanguage"},{"$ref":"#/components/parameters/GetParamPublicServiceTypeGroupId"},{"$ref":"#/components/parameters/GetParamAreaId"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/FormResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FormResult"}}}}}}}},"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Api Key access","name":"api_key","in":"header"}},"parameters":{"GetParamOffset":{"name":"offset","in":"query","description":"Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},"GetParamLimit":{"name":"limit","in":"query","description":"Maximale Anzahl von Ergebnissen.","required":false,"schema":{"type":"integer","format":"int32"}},"GetParamAttributes":{"name":"selectAttributes","in":"query","description":"Einschränkung der Attribute die in der Ergebnismenge zurückgegeben werden sollen. Attribute innerhalb einer Struktur können auch angegeben werden. Dabei muss der Name des Hauptattributes plus ein '.' und der Name des Attributes in der Struktur angegeben werden. Beispiel: [ 'position', 'lastname', 'addresses.city']","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},"GetParamSortAttributes":{"name":"sortAttribute","in":"query","description":"Angabe der Sortierung der Ergebnisse. Richtung wird mit 'ASC'/'DESC' angegeben. Standardrichtung ist aufsteigend (ASC). Attribute innerhalb einer Struktur sind nicht erlaubt. Beispiele: 'lastname ASC', 'lastname DESC'","required":false,"schema":{"type":"string"}},"GetParamFilterTextBlockTypes":{"name":"filterTextBlockTypes","in":"query","description":"Einschränkung der Textblöcke die zurückgegeben weren sollen. Beispiel: [\"BESCHREIBUNG\", \"WENWENDEN\"]","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},"GetParamAgs":{"name":"ags","in":"query","description":"Amtlicher Gemeindeschlüssel","required":false,"schema":{"type":"string"}},"GetParamRs":{"name":"rs","in":"query","description":"Regionalschlüssel","required":false,"schema":{"type":"string"}},"GetParamSearchWord":{"name":"searchWord","in":"query","description":"Suchwort","required":false,"schema":{"type":"string"}},"GetParamSearchNamePrefix":{"name":"searchNamePrefix","in":"query","description":"Suche nach Wortanfang des Namens des Objektes. Z.B. Anfangsbuchstaben einer Tätigkeitsbezeichnung.","required":false,"schema":{"type":"string"}},"GetParamSearchFullText":{"name":"searchFullText","in":"query","description":"Volltextsuche","required":false,"schema":{"type":"boolean"}},"GetParamSearchFuzzy":{"name":"searchFuzzy","in":"query","description":"Ungenaue Suche. Standard ist 'false'","required":false,"schema":{"type":"boolean"}},"GetParamParentId":{"name":"parentId","in":"query","description":"Id des übergeordneten Objekts.","required":false,"schema":{"type":"string","format":"token"}},"GetParamAreaId":{"name":"areaId","in":"query","description":"Id des Gebietes.","required":false,"schema":{"type":"string","format":"token"}},"GetParamPublicServiceTypeId":{"name":"pstId","in":"query","description":"Id der Leistung.","required":false,"schema":{"type":"string","format":"token"}},"GetParamLeikaKey":{"name":"leikaKey","in":"query","description":"Leikakey der zuverwendenden Leistungen.","required":false,"schema":{"type":"string","pattern":"^99\\d{12}$"}},"GetParamTypeId":{"name":"typeId","in":"query","description":"Id des Types auf den die Ergebnisse eingeschränkt werden sollen.","required":false,"schema":{"type":"string","format":"token"}},"GetParamOrganisationalUnitId":{"name":"ouId","in":"query","description":"Id der Organisationseinheit.","required":false,"schema":{"type":"string","format":"token"}},"GetParamOrganisationalUnitCategoryIdArray":{"name":"ouCatId","in":"query","description":"Id der Organisationseinheitkategorie","required":false,"schema":{"type":"array","items":{"type":"string","format":"token"}}},"GetParamPublicServiceTypeCategoryId":{"name":"pstCatId","in":"query","description":"Id der Leistungskategorie","required":false,"schema":{"type":"string","format":"token"}},"GetParamPublicServiceTypeCategoryIdArray":{"name":"pstCatId","in":"query","description":"Id der Leistungskategorie","required":false,"schema":{"type":"array","items":{"type":"string","format":"token"}}},"GetParamPublicServiceTypeGroupId":{"name":"pstGroupId","in":"query","description":"Id der Leistungsgruppe.","required":false,"schema":{"type":"string","format":"token"}},"GetParamParticipantId":{"name":"participantId","in":"query","description":"Id des Teilnehmerkreises","required":false,"schema":{"type":"string","format":"token"}},"GetParamAdressable":{"name":"addressable","in":"query","description":"Auf adressierbare Orte einschränken","required":false,"schema":{"type":"boolean"}},"GetParamFormId":{"name":"formId","in":"query","description":"FormularId","required":false,"schema":{"type":"string","format":"token"}},"GetOuStructureId":{"name":"rootId","in":"query","description":"Id des OU-Hierarchiebaums (Wurzelelement) OuStructure-Id","required":false,"schema":{"type":"string","format":"token"}},"GetOuStructureNodeId":{"name":"leafId","in":"query","description":"Id eines Kindelementes (Blattelement) aus dem OU-Hierarchiebaums - OuStructureNode-Id","required":false,"schema":{"type":"string","format":"token"}},"HeaderParamLanguage":{"name":"Accept-Language","in":"header","description":"Sprache, die verwendet werden soll","required":true,"schema":{"type":"string"}},"HeaderParamNationWideSearch":{"name":"nationwide_search","in":"header","description":"Bundesweite Suche aktivieren. Default: FALSE","required":false,"schema":{"type":"boolean"}},"GetParamOnlineServiceGroupId":{"name":"osGroupId","in":"query","description":"Id der Onlinedienstgruppe.","required":false,"schema":{"type":"string","format":"token"}},"GetParamHasCompetence":{"name":"hasCompetence","in":"query","description":"Suche für Leistungen mit Zuständigkeiten aktivieren. Hat nur Einfluss wenn eine areaId verwendet wird.","required":false,"schema":{"type":"boolean"}}},"schemas":{"Result":{"description":"Ergebnis einer Suche","required":["count"],"properties":{"count":{"type":"integer","format":"int32","example":523,"description":"Anzahl Suchtreffer"},"totalCount":{"type":"integer","format":"int32","example":523,"description":"Gesamtanzahl der Suchtreffer"}}},"ResultEntry":{"description":"Ergebniseintrag","required":["score"],"properties":{"score":{"type":"number","format":"double","example":0.3534,"description":"Wertigkeit des Suchtreffers"}}},"PublicServiceTypeResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PublicServiceTypeResultEntry"}}}}]},"PublicServiceTypeResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/PublicServiceType"}}}]},"PublicServiceTypeGroupResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PublicServiceTypeGroupResultEntry"}}}}]},"PublicServiceTypeGroupResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/PublicServiceTypeGroup"}}}]},"PublicServiceTypeCategoryResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PublicServiceTypeCategoryResultEntry"}}}}]},"PublicServiceTypeCategoryResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/PublicServiceTypeCategory"}}}]},"PublicServiceTypeProcessResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PublicServiceTypeProcessResultEntry"}}}}]},"PublicServiceTypeProcessResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/PublicServiceTypeProcess"}}}]},"OrganisationalUnitResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitResultEntry"}}}}]},"OrganisationalUnitResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OrganisationalUnit"}}}]},"OuCompetenceResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OuCompetenceResultEntry"}}}}]},"OuCompetenceResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OuCompetence"}}}]},"OrganisationalUnitCategoryResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitCategoryResultEntry"}}}}]},"OrganisationalUnitCategoryResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OrganisationalUnitCategory"}}}]},"OnlineServiceResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OnlineServiceResultEntry"}}}}]},"OnlineServiceResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OnlineService"}}}]},"OnlineServiceCompetenceResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OnlineServiceCompetenceResultEntry"}}}}]},"OnlineServiceCompetenceResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OnlineServiceCompetence"}}}]},"OnlineServiceGroupResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OnlineServiceGroupResultEntry"}}}}]},"OnlineServiceGroupResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OnlineServiceGroup"}}}]},"PersonResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PersonResultEntry"}}}}]},"PersonResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/Person"}}}]},"DirectoryPersonResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DirectoryPersonResultEntry"}}}}]},"DirectoryPersonResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/DirectoryPerson"}}}]},"FormResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/FormResultEntry"}}}}]},"FormResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/Form"}}}]},"PaymentProviderResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PaymentProviderResultEntry"}}}}]},"PaymentProviderResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/PaymentProvider"}}}]},"OrganisationalUnitStructureResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitStructureResultEntry"}}}}]},"OrganisationalUnitStructureResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/OrganisationalUnitStructure"}}}]},"DepartmentResult":{"allOf":[{"$ref":"#/components/schemas/Result"},{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DepartmentResultEntry"}}}}]},"DepartmentResultEntry":{"allOf":[{"$ref":"#/components/schemas/ResultEntry"},{"properties":{"object":{"$ref":"#/components/schemas/Department"}}}]},"TextBlock":{"description":"Textblock einer Leistung","properties":{"type":{"$ref":"#/components/schemas/Type"},"text":{"type":"string","example":"Das ist der Block mit der Beschreibung der Leistung.","description":"Inhalt des Textblockes","maxLength":2147483647},"externalLinks":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockExternalLink"},"description":"Externe Links die Informationen zu dem Text enthalten."},"specialisations":{"type":"array","items":{"$ref":"#/components/schemas/SpecialisationText"},"description":"Spezialisierungen des Textblockes"}}},"SpecialisationText":{"description":"Spezialisierung eines Textblockes einer Leistung","properties":{"restrictedArea":{"type":"string","description":"Gebiet"},"text":{"type":"string","example":"Das sind noch weitere Informationen.","description":"Spezialisierter Inhalt für den Textblock","maxLength":2147483647},"externalLinks":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockExternalLink"},"description":"Externe Links die Informationen zu dem Text enthalten."},"legalNorms":{"type":"array","items":{"$ref":"#/components/schemas/TextBlockAdditions"},"description":"Rechtsvorschriften zu der Leistung."}}},"TextBlockExternalLink":{"description":"Externer Link für Textblockergänzung","properties":{"url":{"type":"string","example":"http://www.teleport.de","description":"Url"},"name":{"type":"string","example":"Weiter Informationen","description":"Bezeichnung des Links"},"note":{"type":"string","example":"Hier gibt es keine Bemerkung zu dem Link.","description":"Bemerkung des Links"}}},"TextBlockAdditions":{"description":"Addition des Textblocks Rechtsgrundlagen, hier sind die Rechtsvorschriften zu finden.","properties":{"id":{"type":"string","example":"11","description":"Id der Vorschrift"},"name":{"type":"string","example":"Satzung über die Entschädigung...","description":"Bezeichnung der Vorschrift"}}},"PublicServiceType":{"description":"Leistung","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"type":{"type":"string","example":"LO/LOV/LOVZ","description":"Leistungstyp (Leistungsobjekt (LO), Leistung mit Verrichtung (LOV), Leistung mit Verrichtung und Detail(LOVZ), Auskunft (A))","maxLength":4},"leikaKeys":{"type":"array","items":{"type":"string","maxLength":14,"example":"99005004114000"},"description":"Leikaschlüssel"},"name":{"type":"string","example":"Reisepass beantragen","description":"Bezeichnung","maxLength":4000},"teaser":{"type":"string","example":"Zur Einreise in bestimmte Staaten benötigen deutsche Staatsangehörige einen Reisepass. Über die Einreisebestimmungen weltweit informiert das Auswärtige Amt auf seiner ...","description":"Einleitungstext (Teiltext der gesamten Leistung)","maxLength":4000},"textBlocks":{"type":"array","items":{"$ref":"#/components/schemas/TextBlock"},"description":"Textblöcke"},"periods":{"type":"array","items":{"$ref":"#/components/schemas/Period"},"description":"Fristen"},"servicePeriods":{"type":"array","items":{"$ref":"#/components/schemas/ServicePeriod"},"description":"Bearbeitungsfristen"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"},"description":"Gebühren"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"description":"Dokumente"},"synonyms":{"type":"array","items":{"type":"string","example":"Synonym1"},"description":"Synonyme der Leistung"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"restrictedAreas":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Gebietseinschränkungen der Leistung"},"relatedPublicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Leistungen"},"writtenFormRequired":{"type":"boolean","description":"Schriftform erforderlich"},"trustLevel":{"$ref":"#/components/schemas/Type","description":"Vertrauensniveau"},"sdgInformationAreas":{"type":"array","items":{"$ref":"#/components/schemas/Type"},"description":"SDG-Informationsbereiche"},"receivers":{"type":"array","items":{"$ref":"#/components/schemas/Type"},"description":"leistungsadressaten"},"singlePointOfContact":{"type":"boolean","description":"Kennzeichen 'Einheitliche Stelle'"},"furtherPstObjectsWithActivity":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Weitere LeistungsObjekte mit Verrichtung die diesem LeistungsObjekt entsprechen. (Kann nur gesetzt sein, wenn Typ geleich 'LO')'"},"furtherPstObjectsWithActivityAndDetail":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Weitere LeistungsObjekte mit Verrichtung und Detail die diesem LeistungsObjekt entsprechen. (Kann nur gesetzt sein, wenn Typ gleich 'LO' oder 'LOV')'"},"department":{"$ref":"#/components/schemas/NamedReference","description":"Referenz zum Ressort. Details können über /department/$id abgerufen werden."}}},"Period":{"description":"Frist","properties":{"type":{"type":"string","example":"(SPAN,SPANINTERVAL,DATEINTERVAL)","description":"Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich)"},"restrictedArea":{"type":"string","description":"Gebiet"},"name":{"type":"string","example":"Aufbewahrungsfrist","description":"Bezeichnung","maxLength":4000},"note":{"type":"string","example":"Bemerkung","description":"Bemerkung","maxLength":4000},"validFrom":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig von"},"validTo":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig bis"},"timeSpan":{"type":"integer","format":"int64","example":"5","description":"Zeitraum, gefüllt wenn Typ SPAN, SPANINTERVAL"},"timeSpanTo":{"type":"integer","format":"int64","example":"5","description":"Zeitraum,gefüllt wenn Typ SPANINTERVAL"},"periodUnit":{"type":"string","example":"(DAY,WEEK,MONTH,YEAR,HOUR,WEEKDAY)","description":"Zeitraumeinheit, gefüllt wenn Typ SPAN, SPANINTERVAL","maxLength":100},"dateFrom":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"Datum von, gefüllt wenn Typ DATEINTERVAL"},"dateTo":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"Datum bis, gefüllt wenn Typ DATEINTERVAL"},"PeriodRepetition":{"type":"string","example":"(YEARLY,MONTHLY)","description":"Wiederholung des Datumsbereiches, gefüllt wenn Typ SPAN, SPANINTERVAL","maxLength":100}}},"ServicePeriod":{"description":"Bearbeitungsdauer","properties":{"type":{"type":"string","example":"(SPAN,SPANINTERVAL)","description":"Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich)"},"restrictedArea":{"type":"string","description":"Gebiet"},"name":{"type":"string","example":"Bearbeitungsdauer","description":"Bezeichnung","maxLength":4000},"note":{"type":"string","example":"Bemerkung","description":"Bemerkung","maxLength":4000},"validFrom":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig von"},"validTo":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig bis"},"timeSpan":{"type":"integer","format":"int64","example":"1","description":"Zeitraum"},"timeSpanTo":{"type":"integer","format":"int64","example":"1","description":"Zeitraum bis, gefüllt wenn Typ SPANINTERVAL"},"periodUnit":{"type":"string","example":"(DAY,WEEK,MONTH,YEAR,HOUR,WEEKDAY)","description":"Zeitraumeiheit","maxLength":100}}},"Charge":{"description":"Gebühr","properties":{"type":{"type":"string","example":"(FIX,VARIABLE,FREE,UNDETERMINED)","description":"Gebührentyp"},"restrictedArea":{"type":"string","description":"Gebiet"},"name":{"type":"string","example":"Beitrag","description":"Bezeichnung","maxLength":4000},"note":{"type":"string","example":"Bemerkung","description":"Bemerkung","maxLength":4000},"prepayment":{"type":"boolean","description":"Zahlung per Vorkasse möglich"},"currency":{"type":"string","example":"Euro","description":"Währung","maxLength":255},"paymentNumber":{"type":"string","description":"Kassenzeichen","maxLength":100},"chargeSpecificationUrl":{"type":"string","description":"Url zur Gebührenbildung","maxLength":2000},"validFrom":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig von"},"validTo":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig bis"},"amount":{"type":"number","format":"double","example":"1,30","description":"Betrag, gefüllt wenn Typ FIX"},"upperLimit":{"type":"number","format":"double","example":"1,30","description":"Obergrenze, gefüllt wenn Typ VARIABLE"},"lowerLimit":{"type":"number","format":"double","example":"0,30","description":"Untergrenze, gefüllt wenn Typ VARIABLE"}}},"Document":{"description":"Ein- / Ausgangsdokumente zu Leistungen","properties":{"restrictedArea":{"type":"string","description":"Gebiet"},"direction":{"type":"string","example":"(INBOUND,OUTBOUND)","description":"Dokumentenart (Eingangsdokument, Ausgangsdokument)"},"name":{"type":"string","example":"Beitrag","description":"Bezeichnung","maxLength":4000},"note":{"type":"string","example":"Bemerkung","description":"Bemerkung","maxLength":4000},"validFrom":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig von"},"validTo":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z","description":"gültig bis"}}},"PublicServiceTypeCategory":{"description":"Leistungskategorie","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","example":"Arbeit/Beruf","description":"Bezeichnung","maxLength":4000},"description":{"type":"string","example":"Das ist die Beschreibung der Kategorie.","description":"Beschreibung","maxLength":2147483647},"parentId":{"type":"string","format":"token","example":13534534,"description":"Übergeordnete Kategorie"},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Zugeordnete Leistungen"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"image":{"$ref":"#/components/schemas/Image","description":"Bild"},"pictogramCssClass":{"type":"string","example":"Die CSS-Klasse für das Piktogramm.","description":"Beschreibung","maxLength":255},"position":{"type":"integer","format":"int32"}}},"PublicServiceTypeGroup":{"description":"Leistungsgruppe","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","example":"Melderleistungen","description":"Bezeichnung","maxLength":255},"description":{"type":"string","example":"Melderleistungen","description":"Bezeichnung","maxLength":2000},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Leistungen"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"OnlineAppointment":{"description":"Online-Terminvereinbarung","properties":{"link":{"type":"string","example":"https://xxxxxxx","description":"Link zur Online-Terminvereinbarung","maxLength":4000},"configurationParameters":{"type":"array","items":{"$ref":"#/components/schemas/ConfigParameter"},"description":"Konfigurationsparameter"}}},"OrganisationalUnit":{"description":"Organisationseinheit","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","example":"Einwohnermeldeamt","description":"Bezeichnung","maxLength":4000},"optionalName":{"type":"string","description":"Optionale OE-Kennung aus dem Redaktionssystem"},"synonyms":{"type":"array","items":{"type":"string","example":"Synonym"},"description":"Synonyme der Organisationseinheit"},"description":{"type":"string","example":"Das ist die Beschreibung der Organisationseinheit.","description":"Beschreibung","maxLength":2147483647},"shortDescription":{"type":"string","example":"Das ist die Kurzbeschreibung der Organisationseinheit.","description":"Kurzbeschreibung","maxLength":2147483647},"parentId":{"type":"string","format":"token","example":223423454231,"description":"Übergordnete Organisationseinheit"},"placename":{"type":"string","example":"Halle/Saale","description":"Ort","maxLength":4000},"generalized":{"type":"boolean","description":"Generalisierte OE"},"textgeneralized":{"type":"string","example":"Für die von Ihnen angefragte Leistung konnte noch keine direkte Zuständigkeit ermittelt werden. Informationen zur zuständigen Stelle erhalten Sie bei der angezeigten Adresse.","maxLength":2147483647,"description":"Ist gesetzt wenn 'generalized=true'. Hinweistext für eine Organisationseinheit die momentan nur von der Zentralredaktion angelegt wurde. 'Generalisiert'"},"openingHours":{"type":"string","example":"Mo-Fr 10-00 - 14:00","description":"Öffnungszeiten","maxLength":4000},"appointmentRequired":{"type":"boolean","description":"Gibt an, ob zum Vorsprechen ein Termin nötig ist"},"onlineAppointment":{"$ref":"#/components/schemas/OnlineAppointment","description":"Online-Terminvereinbarung"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"Adressen"},"bankaccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"},"description":"Bankverbindungen"},"communications":{"type":"array","items":{"$ref":"#/components/schemas/Communication"}},"misc":{"type":"string","example":"Sonstige Angaben","description":"Sonstige Angaben","maxLength":4000},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"description":"Bilder. Das Hauptbild befindet sich an erster Stelle!"},"specialInfoServiceCenter":{"type":"string","maxLength":4000},"communicationSystems":{"type":"array","items":{"$ref":"#/components/schemas/CommunicationSystem"},"description":"Kommunikationsmöglichkeiten"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/Type"},"description":"Zahlungsweisen"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"position":{"type":"integer","format":"int64","example":835343545,"description":"Position der OE innerhalb der Struktur."},"organisationalUnitStructures":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Organisationseinheit-Strukturen denen die Oragnisationseinheit zugeordnet ist."},"organisationalUnitCategories":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Organisationseinheit-Kategorien denen die Oragnisationseinheit zugeordnet ist."}}},"ParkingLot":{"description":"Parkplatz","properties":{"name":{"type":"string","example":"Hauptparkplatz","description":"Bezeichnung","maxLength":200},"type":{"$ref":"#/components/schemas/Type"},"count":{"type":"integer","format":"int32","example":"24","description":"Anzahl"},"feeApply":{"type":"boolean","description":"Kostenpflichtig"}}},"PublicTransportationLine":{"description":"Linie (z.B. Buslinie)","properties":{"name":{"type":"string","example":"Linie 6","description":"Bezeichnung","maxLength":200},"type":{"$ref":"#/components/schemas/Type"}}},"PublicTransportationStop":{"description":"Haltestelle","properties":{"name":{"type":"string","example":"Linie 6","description":"Bezeichnung","maxLength":200},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PublicTransportationLine"},"description":"Linien (z.B. Buslinien)"}}},"OuCompetence":{"description":"Zuständigkeit einer Organisationseinhet","properties":{"areas":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Gebiete"},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Leistungen"},"organisationalUnit":{"$ref":"#/components/schemas/NamedReference","description":"Organisationseinheit"}}},"NamedReference":{"description":"ID und Name eines Objektes","properties":{"id":{"type":"string","format":"token","example":1234235423,"description":"ID"},"name":{"type":"string","example":"Hintertupfingen, Reisepass, Bürgerservice","description":"Bezeichnung","maxLength":4000}}},"Person":{"description":"Mitarbeiter","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"lastName":{"type":"string","example":"Muster","description":"Nachname","maxLength":200},"firstName":{"type":"string","example":"Max","description":"Vorname","maxLength":200},"nameAddition":{"type":"string","example":"Dr.","description":"Zusatz","maxLength":50},"title":{"type":"string","example":"Herr","description":"Anrede","maxLength":50},"position":{"type":"string","example":"Leiter","description":"Position","maxLength":4000},"function":{"type":"string","example":"IT-Verantwortliche","description":"Funktion","maxLength":4000},"department":{"type":"string","example":"Einkauf","description":"Bereich","maxLength":4000},"room":{"type":"string","example":"122","description":"Raum","maxLength":50},"comment":{"type":"string","example":"","maxLength":4000,"description":"Anmerkungen zur Person"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"Adressen"},"communication":{"type":"array","items":{"$ref":"#/components/schemas/Communication"},"description":"Kommunikationsdaten"},"image":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"description":"Bilder"},"competences":{"type":"array","items":{"$ref":"#/components/schemas/PersonCompetence"},"description":"Zuständigkeiten"},"organisationalUnits":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Organisationseinheiten"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"anonymize":{"type":"boolean","description":"Mitarbeiter-Daten anonymisieren"},"visible":{"type":"boolean","description":"Mitarbeiter ist sichtbar"}}},"PersonCompetence":{"description":"Zuständigkeit eines Mitarbeiters","properties":{"areas":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Gebiete"},"publicServiceType":{"$ref":"#/components/schemas/NamedReference"},"competenceCriterias":{"type":"array","items":{"type":"string","example":"Nachname A-F"},"description":"Zuständigkeitskriterien"},"miscCriterias":{"type":"array","items":{"type":"string","example":"Nur für ....."},"description":"Sonstige Kriterien"}}},"DirectoryPerson":{"description":"Mitarbeiter aus Verzeichnis","properties":{"id":{"type":"string","format":"token","example":835343545},"lastName":{"type":"string","example":"Muster","description":"Nachname","maxLength":200},"firstName":{"type":"string","example":"Max","description":"Vorname","maxLength":200},"nameAddition":{"type":"string","example":"Dr.","description":"Zusatz","maxLength":50},"title":{"type":"string","example":"Herr","description":"Anrede","maxLength":50},"position":{"type":"string","example":"Leiter","description":"Position","maxLength":4000},"function":{"type":"string","example":"IT-Verantwortliche","description":"Funktion","maxLength":4000},"department":{"type":"string","example":"Einkauf","description":"Bereich","maxLength":4000},"room":{"type":"string","example":"122","description":"Raum","maxLength":50},"comment":{"type":"string","example":"","maxLength":4000},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"description":"Adressen"},"communication":{"type":"array","items":{"$ref":"#/components/schemas/Communication"},"description":"Kommunikationsdaten"},"image":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"description":"Bilder"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"anonymize":{"type":"boolean","description":"Mitarbeiter-Daten anonymisieren"},"visible":{"type":"boolean","description":"Mitarbeiter ist sichtbar"}}},"Form":{"description":"Formular","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","example":"Formularname","description":"Bezeichnung","maxLength":4000},"description":{"type":"string","example":"Das ist eine Beschreibung des Formulars","description":"Beschreibung","maxLength":2147483647},"links":{"type":"array","items":{"$ref":"#/components/schemas/FormLink"},"description":"Downloadlinks zu den Formularen"},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Leistungen"},"organisationalUnits":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Organisationseinheiten"},"localForm":{"type":"boolean","description":"lokales Formular"}}},"FormLink":{"description":"Link zum Formular um diese heruntertzuladen/anzuzeigen","properties":{"type":{"$ref":"#/components/schemas/Type"},"url":{"type":"string","example":"http://abababab.xy/","description":"Url","maxLength":2000},"size":{"type":"integer","format":"int64","description":"Die Dateigröße in Bytes","example":342948023},"mimeType":{"type":"string","example":"application/pdf","description":"MIME-Type","maxLength":50}}},"Image":{"description":"Bild","properties":{"mimeType":{"type":"string","example":"image/jpeg","description":"Bildtyp","maxLength":100},"originalFileName":{"type":"string","example":"Aufname_001.jpg","description":"Originaldateiname","maxLength":1000},"fileSize":{"type":"string","example":"100 MB","description":"Größe","maxLength":100},"name":{"type":"string","example":"Luftbild","description":"Bezeichnung","maxLength":4000},"description":{"type":"string","example":"Das ist eine Beschreibung des Bildes","description":"Beschreibung","maxLength":4000},"source":{"type":"string","example":"Aus dem Buch Bilder der Welt.","description":"Quellenkennzeichnung","maxLength":1000},"url":{"type":"string","example":"http://abababab.xy/","description":"Downloadurl","maxLength":2000},"height":{"type":"integer","format":"int32","example":"480","description":"Höhe des Bildes"},"width":{"type":"integer","format":"int32","example":"640","description":"Breite des Bildes"}}},"AddressDescriptionLink":{"description":"Adresse","properties":{"link":{"type":"string","example":"https:/xxxxxx","description":"Link zur Anfahrtsbeschreibung","maxLength":1000},"linkTitle":{"type":"string","example":"Beschreibungstitel","description":"Titel für Link zur Anfahrtsbeschreibung","maxLength":256}}},"EfaLink":{"description":"Efa-Link zur jeweiligen Adresse","properties":{"link":{"type":"string","example":"https://xxxxxx","description":"Efa-Link zur Adresse","maxLength":1000}}},"Address":{"description":"Adresse","properties":{"street":{"type":"string","example":"Musterstraße 57b","description":"Strasse","maxLength":256},"houseNumber":{"type":"string","example":"57b","description":"Hausnummer","maxLength":50},"area":{"$ref":"#/components/schemas/NamedReference","description":"Ort"},"mailbox":{"type":"string","example":"23423534534","description":"Postfach","maxLength":50},"zipcode":{"type":"string","example":"06108","description":"Postleitzahl","maxLength":5},"comment":{"type":"string","example":"sample name","description":"Bemerkungen","maxLength":4000},"geoLocation":{"$ref":"#/components/schemas/GeoLocation"},"type":{"$ref":"#/components/schemas/Type"},"descriptionLink":{"$ref":"#/components/schemas/AddressDescriptionLink","description":"Link zur Anfahrtsbeschreibung"},"transportationStops":{"type":"array","items":{"$ref":"#/components/schemas/PublicTransportationStop"},"description":"Haltestellen"},"parkingLots":{"type":"array","items":{"$ref":"#/components/schemas/ParkingLot"},"description":"Parkplätze"},"elevator":{"type":"boolean","description":"Fahrstuhl vorhanden"},"wheelchairAccessible":{"type":"boolean","description":"Barrierefreier Zugang"},"accessibleInfo":{"type":"string","example":"Zusätzliche Angaben zu Barrierefrei","description":"Zusätzliche Angaben zu Barrierefrei","maxLength":4000}}},"Communication":{"description":"Kommunikationskanal (z.B. E-Mail, Telefon, ...)","properties":{"type":{"$ref":"#/components/schemas/Type"},"title":{"type":"string","example":"Zentrale","description":"Bezeichnung","maxLength":4000},"note":{"type":"string","example":"Irgendeine Bemerkung","description":"Bemerkung","maxLength":4000},"value":{"type":"string","example":"+49 345 2056 0","description":"Wert","maxLength":4000}}},"Type":{"description":"Typ","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":835343545},"name":{"type":"string","example":"Type (z.b. PostAdress, Telefon, Stadt, etc.","description":"Type (z.b. PostAdress, Telefon, Stadt, etc.","maxLength":4000},"description":{"type":"string","example":"Beschreibung/Hinweise","description":"Beschreibung","maxLength":2147483647},"key":{"type":"string","example":"KEY","description":"Schlüssel","maxLength":100},"notPublic":{"type":"boolean","description":"öffentlich nicht sichtbarer Typ"}}},"BankAccount":{"description":"Zahlungsdaten","properties":{"payeeName":{"type":"string","description":"Empfänger","maxLength":70},"bank":{"type":"string","description":"Kreditinstitut","maxLength":70},"IBAN":{"type":"string","description":"IBAN","maxLength":34},"BIC":{"type":"string","description":"BIC","maxLength":11},"publicVisible":{"type":"boolean","description":"öffentlich sichtbar"},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Einschränkung auf Leitungen"},"notes":{"type":"string","description":"Hinweise zur Verwendung","maxLength":4000}}},"CommunicationSystem":{"description":"Kommunikations-System","properties":{"identification":{"type":"string","description":"Kennung","maxLength":500},"identificationAddon":{"type":"string","description":"Zusatz","maxLength":500},"type":{"$ref":"#/components/schemas/Type"}}},"GeoLocation":{"description":"Geokoordinaten","properties":{"coordinate1":{"type":"number","format":"double","example":"34.2345345345","description":"Als 'coordinate1' können in Abhängigkeit vom Koordinatensystem folgende Werte angegeben werden: Ostwert für UTM, Rechtswert für Gauß-Krüger-Koordinatensystem und Soldnerkoordinatensystem, geographische Länge für geographisches Koordinatensystem."},"coordinate2":{"type":"number","format":"double","example":"34.2345345345","description":"Als 'coordinate2' können in Abhängigkeit vom Koordinatensystem folgende Werte angegeben werden: Nordwert für UTM, Hochwert für Gauß-Krüger-Koordinatensystem und Soldnerkoordinatensystem, geographische Breite für geographisches Koordinatensystem."},"projection":{"type":"string","example":"epsg:23242","description":"Koordinatensystem der Geolokation. (EPSG:XXXXX)","maxLength":40}}},"Language":{"description":"Sprache","properties":{"code":{"description":"Sprach-Code ","type":"string","example":"de_DE"},"name":{"type":"string","description":"Bezeichnung","example":"Deutsch"},"nativeName":{"type":"string","description":"Eigenbezeichung","example":"English"},"shortName":{"type":"string","description":"Kurzbezeichung","example":"DELS"},"defaultLanguage":{"type":"boolean","description":"Standard-Sprache","example":"true"}}},"OnlineService":{"description":"Onlinedienst","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","example":"Onlinedienst für ....","description":"öffentliche Bezeichnung","maxLength":4000},"description":{"type":"string","example":"Das ist die Beschreibung des Onlinedienstes.","description":"Beschreibung","maxLength":2147483647},"link":{"type":"string","example":"https://xxxxxxx","description":"Link zum Onlinedienst.","maxLength":4000},"linkTitle":{"type":"string","example":"Hier gehts zum Onlinedienst","description":"interne Bezeichnung des Onlinedienst.","maxLength":4000},"image":{"$ref":"#/components/schemas/Image","description":"Bild"},"configurationParameters":{"type":"array","items":{"$ref":"#/components/schemas/ConfigParameter"},"description":"Konfigurationsparameter"},"deliveryChannel":{"$ref":"#/components/schemas/DeliveryChannel","description":"Zustellungskanal des Online-Dienstes"},"validTo":{"description":"Das Datum, bis zu dem der Online-Dienst gültig ist","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"trustLevel":{"type":"string","example":"NIEDRIG","description":"Das Vertrauensniveau des Online-Dienstes: NIEDRIG, SUBSTANTIELL oder HOCH","maxLength":11},"lastUpdated":{"description":"Letzte Aktualisierung des Objektes.","type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/Type"},"description":"elektronische Zahlungsweisen"},"paymentProvider":{"$ref":"#/components/schemas/NamedReference","description":"Referenz zum Zahlungsdienst"},"identificationTypes":{"type":"array","items":{"$ref":"#/components/schemas/Type"},"description":"Identifizierungsmittel"},"gdprText":{"type":"string","example":"Hinweis nach §13 DSGVO: bla bla.","description":"Optionaler DSGVO-Hinweis","maxLength":2147483647},"onlinePaymentRequired":{"type":"string","pattern":"TRUE|FALSE|OPTIONAL","description":"Sagt aus ob der Bezahlvorgang Plicht(TRUE), Optional(OPTIONAL) ist oder nicht benötigt (FALSE) wird."},"supportedLanguages":{"type":"array","items":{"type":"string","example":"de_DE"},"description":"Unterstützte Sprachen des Onlinedienstes. Die Sprachcodes entsprechen RFC3066."}}},"OnlineServiceHelp":{"description":"OnlineService Hilfelink und Hilfetext","properties":{"link":{"type":"string","example":"https://xxxxxx","description":"Hilfelink des gesuchten Onlinedienstes","maxLength":1000},"text":{"type":"string","example":"Hilfetext eines Onlinedienst","description":"Hilfetext des gesuchten Onlinedienstes","maxLength":4000}}},"ConfigParameter":{"description":"Konfigurationsparameter für den OnlineService","properties":{"parameter":{"type":"string","example":"param","description":"Parameter-Name","maxLength":100},"value":{"type":"string","example":"abcdefgh","description":"Fester Wert","maxLength":100},"selection":{"type":"array","items":{"type":"string","example":"Eine von mehreren Auswahloptionen","description":"Fester Wert","maxLength":1000},"description":"Eine von mehreren Auswahloptionen"},"mandatory":{"type":"boolean","description":"Gibt an, ob der Wert gesetzt sein muss"},"useInUrl":{"type":"boolean","description":"Gibt an, ob der Wert gesetzt sein muss"},"help":{"type":"string","example":"Der Parameter wird verwendet um ....","description":"Eine Beschreibung des Parameters (Ausfüll-Hilfe)","maxLength":4000},"type":{"type":"string","example":"TEXT, AUSWAHL, LEISTUNG_ID, GEBIET_ID, OE_ID, LEIKA","description":"Der Typ des Konfigurationsparameters: Text, Auswahl oder dynamisch(Leistungs-ID, Gebiets-ID, OE-ID, LeiKa-Schlüssel)","maxLength":11}}},"DeliveryChannel":{"description":"Zustellungskanal eines Online-Dienstes","properties":{"channel":{"type":"string","example":"Das ist ein freier Text falls kein Kontaktsystem angegeben werden kann.","description":"Freitext, falls kein Kontaktsystem angegeben werden kann","maxLength":100},"communicationSystem":{"$ref":"#/components/schemas/CommunicationSystem","description":"Kommunikationsmöglichkeiten"}}},"OnlineServiceCompetence":{"description":"Zuständigkeit eines Onlinedienstes","properties":{"onlineService":{"$ref":"#/components/schemas/NamedReference","description":"Onlinedienst"},"areas":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Gebiete"},"publicServiceTypes":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Leistungen"}}},"OnlineServiceGroup":{"description":"Onlinedienstegruppe","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","example":"Besondere OnlineDienste","description":"Bezeichnung","maxLength":255},"description":{"type":"string","example":"Besondere OnlineDienste","description":"Beschreibung","maxLength":2000},"onlineServices":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Onlinedienste"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"PublicServiceTypeProcess":{"description":"Prozess zu einer Leistung","properties":{"id":{"description":"Id des Objektes","type":"string","format":"token","example":1234234},"name":{"type":"string","description":"Bezeichnung des Prozesses"},"uri":{"type":"string","description":"Url zum Prozess"},"referenceId":{"$ref":"#/components/schemas/NamedReference","description":"Externe ProzessId/Referenz"},"publicServiceType":{"$ref":"#/components/schemas/NamedReference","description":"Referenz zur Leistung"},"type":{"$ref":"#/components/schemas/Type"}}},"PaymentProvider":{"description":"Zahlungsdienst","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","example":"PayPal","description":"Bezeichnung","maxLength":255},"description":{"type":"string","example":"Das ist ein Zahlungsdienst","description":"Beschreibung","maxLength":2000},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Zahlungsdienste"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"OrganisationalUnitStructure":{"description":"Hierachie von Organisationseinheiten","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","example":"PayPal","description":"Bezeichnung","maxLength":255},"title":{"type":"string","example":"Title","description":"Bezeichnung","maxLength":255},"description":{"type":"string","example":"Das ist ein Zahlungsdienst","description":"Beschreibung","maxLength":2000},"structure":{"$ref":"#/components/schemas/OrganisationalUnitStructureNode","description":"Startknoten der Struktur"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"OrganisationalUnitStructureNode":{"description":"Knoten einer Hierachie von Organisationseinheiten","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","example":"Allgemeine Bereiche","description":"Bezeichnung","maxLength":255},"organisationalUnit":{"$ref":"#/components/schemas/NamedReference","description":"Organisationseinheit des Knoten"},"description":{"type":"string","example":"Beschreibung","description":"Beschreibung des Hierachrieknotens","maxLength":2000},"children":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationalUnitStructureNode"},"description":"untergordnete Knoten einer Hierachie von Organisationseinheiten"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"OrganisationalUnitCategory":{"description":"Oragnisationseinheitkategorie","properties":{"id":{"type":"string","format":"token","example":42314122},"name":{"type":"string","example":"Ämter","description":"Bezeichnung","maxLength":4000},"description":{"type":"string","example":"Das ist die Beschreibung der Kategorie.","description":"Beschreibung","maxLength":2147483647},"parentId":{"type":"string","format":"token","example":13534534,"description":"Übergeordnete Kategorie"},"organisationalUnits":{"type":"array","items":{"$ref":"#/components/schemas/NamedReference"},"description":"Zugeordnete Organisationseinheiten"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"},"position":{"type":"integer","format":"int32"}}},"OrganisationalUnitSynonym":{"description":"Liste mit Synonymen die in Organisationseinheiten übernomen werden können.Diese werden nicht referenziert.","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","maxLength":250,"example":"Amt"},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}},"Department":{"description":"Ressort","properties":{"id":{"type":"string","format":"token","example":34563423},"name":{"type":"string","example":"PayPal","description":"Bezeichnung","maxLength":255},"emailReceivers":{"type":"string","example":"max.muster@example.com ","description":"E-Mail-Empfänger des Ressort","maxLength":2000},"lastUpdated":{"type":"string","format":"date-time","example":"2015-06-30T07:06:57.984Z"}}}}},"servers":[{"url":"https://restapi-v4-rp.infodienste.de:443/"}]}