1. Introduction

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.

Auf der linken Seite sehen Sie das Inhaltsverzeichnis. Benutzen Sie dieses, um die genauen Definitionen der Methoden und Datentypen zu erhalten.

1.1. Contact information

TSA

    Website: infodienste.de
    Contact Email: support@tsa.de

1.2. Version

4.10.002

1.3. URI scheme

Schemes: HTTPS

2. Access

  • APIKey KeyParamName: api_key, KeyInQuery: false, KeyInHeader: true

3. Endpoints

3.1. Allgemein

commonLanguagesGet

GET /common/languages

Description

Gibt alle Sprachen zurück.

Parameters
Return Type

array[Language]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 1. http response codes
Code Message Datatype

200

successful operation

List[Language]
Samples

commonOnlineApplicationLinkGet

GET /common/onlineApplicationLink

Description

Gibt die Links zur elektronischen Antragstellung zurück.

Parameters
Query Parameters
Name Description Required Default Pattern

pstId

Id der Leistung.

-

null

areaId

Id des Gebietes.

-

null
Return Type

array[TextBlockExternalLink]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 2. http response codes
Code Message Datatype

200

successful operation

List[TextBlockExternalLink]
Samples

commonOustructureGet

GET /common/oustructure

Description

Gibt alle, zusätzlich zur normalen Struktur, definiereten Hierarchien von Organisationseinheiten zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[OrganisationalUnitStructure]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 3. http response codes
Code Message Datatype

200

successful operation

List[OrganisationalUnitStructure]
Samples

commonOustructureIdGet

GET /common/oustructure/{id}

Description

Gibt eine, zusätzlich zur normalen Struktur, definierete Hierarchie für Organisationseinheiten zurück

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Struktur/Hierarchie.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

OrganisationalUnitStructure

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 4. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitStructure[OrganisationalUnitStructure]

404

group not found

<<>>
Samples

commonOusynonymGet

GET /common/ousynonym

Description

Gibt alle zentral gepflegten Synonyme für Organisationseinheiten zurück. Diese werden an Organisationseinheiten verwendet, jedoch nicht referenziert.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[OrganisationalUnitSynonym]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 5. http response codes
Code Message Datatype

200

successful operation

List[OrganisationalUnitSynonym]
Samples

commonPortalLinkGet

GET /common/portalLink

Description

Gibt den Link zum Portal zurück.

Parameters
Query Parameters
Name Description Required Default Pattern

pstId

Id der Leistung.

-

null

areaId

Id des Gebietes.

-

null

ouId

Id der Organisationseinheit.

-

null

formId

FormularId

-

null

pstCatId

Id der Leistungskategorie

-

null
Return Type

[String]

Content Type

  • text/plain

Responses
Table 6. http response codes
Code Message Datatype

200

successful operation

String[[string]]

404

object not found

<<>>
Samples

departmentFindGet

GET /department/find

Description

Benutzen Sie diese Funktion um Ressorts zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

DepartmentResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 7. http response codes
Code Message Datatype

200

successful operation

DepartmentResult[DepartmentResult]
Samples

departmentIdGet

GET /department/{id}

Description

Ermittelt ein Ressort der Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Ressort.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

Department

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 8. http response codes
Code Message Datatype

200

successful operation

Department[Department]

404

group not found

<<>>
Samples

directoryPersonFindAllGet

GET /directoryPerson/findAll

Description

Gibt Personen aus dem Mitarbeiterverzeichnis zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

DirectoryPersonResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 9. http response codes
Code Message Datatype

200

successful operation

DirectoryPersonResult[DirectoryPersonResult]
Samples

paymentProviderFindGet

GET /paymentProvider/find

Description

Benutzen Sie diese Funktion um Zahlungsdienste zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

PaymentProviderResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 10. http response codes
Code Message Datatype

200

successful operation

PaymentProviderResult[PaymentProviderResult]
Samples

paymentProviderIdGet

GET /paymentProvider/{id}

Description

Ermittelt einen Zahlungsdienst anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Zahlungsdienstleister.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

PaymentProvider

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 11. http response codes
Code Message Datatype

200

successful operation

PaymentProvider[PaymentProvider]

404

group not found

<<>>
Samples

typesAddressGet

GET /types/address

Description

Gibt alle Adresstypen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 12. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesCommunicationGet

GET /types/communication

Description

Gibt alle Kommunikationstypen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 13. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesCompetenceGet

GET /types/competence

Description

Gibt alle Zuständigkeitskriterium-Typen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 14. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesContactGet

GET /types/contact

Description

Gibt alle Kontaktsystem-Typen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 15. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesParkingLotGet

GET /types/parkingLot

Description

Gibt alle Parkplatztypen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 16. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesPaymentMethodGet

GET /types/paymentMethod

Description

Gibt alle Zahlungsarten zurück (Kosten bei Leistungen).

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 17. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesPublicTransportationLineGet

GET /types/publicTransportationLine

Description

Gibt alle Verkehrsmittel-Typen zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 18. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

typesTextBlockGet

GET /types/textBlock

Description

Gibt alle Typen für Textblöcke zurück.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[Type]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 19. http response codes
Code Message Datatype

200

successful operation

List[Type]

404

class not found

<<>>
Samples

3.2. Form

formFindGet

GET /form/find

Description

Benutzen Sie diese Funktion um Formulare zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

pstId

Id der Leistung.

-

null

ouId

Id der Organisationseinheit.

-

null

subOrganisationalUnits

Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs

-

null

includeLocalForms

Lokale Formulare auch ermitteln. Default: False

X

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

pstGroupId

Id der Leistungsgruppe.

-

null

areaId

Id des Gebietes.

-

null
Return Type

FormResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 20. http response codes
Code Message Datatype

200

successful operation

FormResult[FormResult]
Samples

formIdGet

GET /form/{id}

Description

Ermittelt ein Formular anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Formulars.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

Form

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 21. http response codes
Code Message Datatype

200

successful operation

Form[Form]

404

form not found

<<>>
Samples

3.3. Leistung

pstAssignedLeikaKeysGet

GET /pst/assignedLeikaKeys

Description

Benutzen Sie diese Funktion um alle verwendeten Leika-Schlüssel zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

participantId

Id des Teilnehmerkreises

-

null
Return Type

[List]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 22. http response codes
Code Message Datatype

200

successful operation

List[[string]]
Samples

pstByLeikaKeyLeikaKeyGet

GET /pst/byLeikaKey/{leikaKey}

Description

Ermittelt Leistungen anhand des Leika-Schlüssels.

Parameters
Path Parameters
Name Description Required Default Pattern

leikaKey

LeikaSchlüssel der Leistung.

X

null

/^99\d{12}$/
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

areaId

Id des Gebietes wofür die Leistungen spezialisiert werden sollen.

-

null

selectAttributes

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'] [String]

-

null
Return Type

PublicServiceTypeResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 23. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeResult[PublicServiceTypeResult]
Samples

pstCategoryFindGet

GET /pstCategory/find

Description

Benutzen Sie diese Funktion um Leistungskategorien zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

parentId

Id des übergeordneten Objekts.

-

null

pstId

Id der Leistung.

-

null

pstGroupId

Id der Leistungsgruppe.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

PublicServiceTypeCategoryResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 24. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeCategoryResult[PublicServiceTypeCategoryResult]
Samples

pstCategoryIdGet

GET /pstCategory/{id}

Description

Ermittelt eine Leistungskategorie anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Leistungskategorie.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

PublicServiceTypeCategory

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 25. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeCategory[PublicServiceTypeCategory]

404

category not found

<<>>
Samples

pstFindAllGet

GET /pst/findAll

Description

Benutzen Sie diese Funktion um alle Leistungen zu finden. Dabei werden immer alle gebietseingeschränkten Leistungen mit zurück gegeben.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

areaRS

Zweistelliger Bundsland-Regionalschlüssel für das die Abfrage gilt. Wenn leer, dann eigenes Bundesland der RestApi.

-

null

/^[0-9]{2}$/

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

filterTextBlockTypes

Einschränkung der Textblöcke die zurückgegeben weren sollen. Beispiel: [&quot;BESCHREIBUNG&quot;, &quot;WENWENDEN&quot;] [String]

-

null
Return Type

PublicServiceTypeResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 26. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeResult[PublicServiceTypeResult]
Samples

pstFindByIdsGet

GET /pst/findByIds

Description

Ermittelt Leistungen anhand der Ids.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

id

Id der Leistung. [String]

X

null

areaId

Id des Gebietes wofür die Leistung spezialisiert werden soll.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null
Return Type

PublicServiceTypeResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 27. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeResult[PublicServiceTypeResult]

404

publicservicetype not found

<<>>
Samples

pstFindGet

GET /pst/find

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
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

hasCompetence

Suche für Leistungen mit Zuständigkeiten aktivieren. Hat nur Einfluss wenn eine areaId verwendet wird.

-

null

areaId

Id des Gebietes.

-

null

pstCatId

Id der Leistungskategorie [String]

-

null

pstGroupId

Id der Leistungsgruppe.

-

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

filterTextBlockTypes

Einschränkung der Textblöcke die zurückgegeben weren sollen. Beispiel: [&quot;BESCHREIBUNG&quot;, &quot;WENWENDEN&quot;] [String]

-

null
Return Type

PublicServiceTypeResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 28. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeResult[PublicServiceTypeResult]
Samples

pstGroupFindGet

GET /pstGroup/find

Description

Benutzen Sie diese Funktion um Leistungsgruppen zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

PublicServiceTypeGroupResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 29. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeGroupResult[PublicServiceTypeGroupResult]
Samples

pstGroupIdGet

GET /pstGroup/{id}

Description

Ermittelt eine Leistungsgruppe anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Leistungsgruppe.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

PublicServiceTypeGroup

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 30. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeGroup[PublicServiceTypeGroup]

404

group not found

<<>>
Samples

pstIdGet

GET /pst/{id}

Description

Ermittelt eine Leistung anhand der Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Leistung.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

areaId

Id des Gebietes wofür die Leistung spezialisiert werden soll.

-

null

selectAttributes

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'] [String]

-

null
Return Type

PublicServiceType

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 31. http response codes
Code Message Datatype

200

successful operation

PublicServiceType[PublicServiceType]

404

publicservicetype not found

<<>>
Samples

pstProcessFindGet

GET /pstProcess/find

Description

Benutzen Sie diese Funktion um Process von Leistungen zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

pstId

Id der Leistung.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

PublicServiceTypeProcessResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 32. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeProcessResult[PublicServiceTypeProcessResult]
Samples

pstProcessIdGet

GET /pstProcess/{id}

Description

Ermittelt einen Process einer Leistung anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Processes.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

PublicServiceTypeProcess

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 33. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeProcess[PublicServiceTypeProcess]

404

process not found

<<>>
Samples

pstStartsWithGet

GET /pst/startsWith

Description

Benutzen Sie diese Funktion um Leistungen anhand von Anfangsbuchstaben zu finden, mit denen der Leistungsname beginnt.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

startsWith

Beginn des Leistungsnamen [String]

X

null

areaId

Id des Gebietes.

-

null

pstCatId

Id der Leistungskategorie [String]

-

null

pstGroupId

Id der Leistungsgruppe.

-

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

filterTextBlockTypes

Einschränkung der Textblöcke die zurückgegeben weren sollen. Beispiel: [&quot;BESCHREIBUNG&quot;, &quot;WENWENDEN&quot;] [String]

-

null
Return Type

PublicServiceTypeResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 34. http response codes
Code Message Datatype

200

successful operation

PublicServiceTypeResult[PublicServiceTypeResult]
Samples

3.4. Onlinedienst

osCompetenceFindGet

GET /osCompetence/find

Description

Benutzen Sie diese Funktion um alle Zuständigkeiten von Onlinediensten zu ermitteln.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

areaId

Id des Gebietes.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OnlineServiceCompetenceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 35. http response codes
Code Message Datatype

200

successful operation

OnlineServiceCompetenceResult[OnlineServiceCompetenceResult]
Samples

osCompetenceIdGet

GET /osCompetence/{id}

Description

Benutzen Sie diese Funktion um die Zuständigkeiten eines Onlinedienstes zu ermitteln.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Onlinedienstes.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

areaId

Id des Gebietes.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OnlineServiceCompetenceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 36. http response codes
Code Message Datatype

200

successful operation

OnlineServiceCompetenceResult[OnlineServiceCompetenceResult]
Samples

osFindByCompetenceGet

GET /os/findByCompetence

Description

Benutzen Sie diese Funktion um Onlinedienste anhand ihrer Zuständigkeit für eine Gebiet zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

areaId

Id des Gebietes wofür die Onlinedienste zuständig sind.

X

null

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OnlineServiceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 37. http response codes
Code Message Datatype

200

successful operation

OnlineServiceResult[OnlineServiceResult]
Samples

osFindByIdsGet

GET /os/findByIds

Description

Ermittelt Onlinedienste anhand der Ids.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

id

Id des Onlinedienstes. [String]

X

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null
Return Type

OnlineServiceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 38. http response codes
Code Message Datatype

200

successful operation

OnlineServiceResult[OnlineServiceResult]

404

publicservicetype not found

<<>>
Samples

osFindGet

GET /os/find

Description

Benutzen Sie diese Funktion um Onlinedienste anhand von Suchbegriffen zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

osGroupId

Id der Onlinedienstgruppe.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OnlineServiceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 39. http response codes
Code Message Datatype

200

successful operation

OnlineServiceResult[OnlineServiceResult]
Samples

osGroupFindGet

GET /osGroup/find

Description

Benutzen Sie diese Funktion um Gruppen von Onlinediensten zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OnlineServiceGroupResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 40. http response codes
Code Message Datatype

200

successful operation

OnlineServiceGroupResult[OnlineServiceGroupResult]
Samples

osGroupIdGet

GET /osGroup/{id}

Description

Ermittelt eine Onlinedienstgruppe anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Onlinedienstgruppe.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

OnlineServiceGroup

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 41. http response codes
Code Message Datatype

200

successful operation

OnlineServiceGroup[OnlineServiceGroup]

404

group not found

<<>>
Samples

osIdGet

GET /os/{id}

Description

Ermittelt einen Onlinedienst anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Onlinedienstes.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

OnlineService

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 42. http response codes
Code Message Datatype

200

successful operation

OnlineService[OnlineService]

404

onlineservice not found

<<>>
Samples

osIdHelpGet

GET /os/{id}/help

Description

Ermittelt, falls vorhanden, den Hilfelink und Hilfetext.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id des Onlinedienstes.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

OnlineServiceHelp

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 43. http response codes
Code Message Datatype

200

successful operation

OnlineServiceHelp[OnlineServiceHelp]

404

onlineservice not found

<<>>
Samples

3.5. Organisationseinheit

ouCategoryFindGet

GET /ouCategory/find

Description

Benutzen Sie diese Funktion um Organisationseinheitkategorien zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

parentId

Id des übergeordneten Objekts.

-

null

ouId

Id der Organisationseinheit.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OrganisationalUnitCategoryResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 44. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitCategoryResult[OrganisationalUnitCategoryResult]
Samples

ouCategoryIdGet

GET /ouCategory/{id}

Description

Ermittelt eine Organisationseinheitkategorie anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheitkategorie.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

OrganisationalUnitCategory

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 45. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitCategory[OrganisationalUnitCategory]

404

category not found

<<>>
Samples

ouCompetenceFindGet

GET /ouCompetence/find

Description

Benutzen Sie diese Funktion um alle Zuständigkeiten von Organisationseinheiten zu ermitteln.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

areaId

Id des Gebietes.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OuCompetenceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 46. http response codes
Code Message Datatype

200

successful operation

OuCompetenceResult[OuCompetenceResult]
Samples

ouCompetenceIdGet

GET /ouCompetence/{id}

Description

Benutzen Sie diese Funktion um die Zuständigkeiten einer Organisationseinheit zu ermitteln.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

subOrganisationalUnits

Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs

-

null

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

areaId

Id des Gebietes.

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OuCompetenceResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 47. http response codes
Code Message Datatype

200

successful operation

OuCompetenceResult[OuCompetenceResult]
Samples

ouFindByAreaGet

GET /ou/findByArea

Description

Benutzen Sie diese Funktion um Organisationseinheiten an einem bestimmten Standort zu finden. Es werden die Orte an Adressen durchsucht.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

areaId

Id des Gebietes des Ortes in der Adresse der Organisationseinheiten.

X

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OrganisationalUnitResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 48. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitResult[OrganisationalUnitResult]
Samples

ouFindByCompetenceGet

GET /ou/findByCompetence

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
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

areaId

Id des Gebietes wofür die Organisationseinheiten zuständig sind.

X

null

pstId

Id der Leistung.

-

null

leikaKey

Leikakey der zuverwendenden Leistungen.

-

null

/^99\d{12}$/

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OrganisationalUnitResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 49. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitResult[OrganisationalUnitResult]
Samples

ouFindByIdsGet

GET /ou/findByIds

Description

Ermittelt Organisationseinheiten anhand der Ids.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit. [String]

X

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null
Return Type

OrganisationalUnitResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 50. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitResult[OrganisationalUnitResult]

404

publicservicetype not found

<<>>
Samples

ouFindByStructureGet

GET /ou/findByStructure

Description

Benutzen Sie diese Funktion um Organisationseinheiten anhand der OU-Baumhierarchie-Id oder einer der Blätter der Baumhierarchie zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

rootId

Id des OU-Hierarchiebaums (Wurzelelement) OuStructure-Id

-

null

leafId

Id eines Kindelementes (Blattelement) aus dem OU-Hierarchiebaums - OuStructureNode-Id

-

null

selectAttributes

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'] [String]

-

null

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

startsWith

Erster Buchstabe vom Namen der Organisationseinheit. [String]

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

sortAttribute

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'

-

null
Return Type

OrganisationalUnitResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 51. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitResult[OrganisationalUnitResult]
Samples

ouFindGet

GET /ou/find

Description

Benutzen Sie diese Funktion um Organisationseinheiten anhand von Suchbegriffen zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

parentId

Id des übergeordneten Objekts.

-

null

ouCatId

Id der Organisationseinheitkategorie [String]

-

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null
Return Type

OrganisationalUnitResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 52. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnitResult[OrganisationalUnitResult]
Samples

ouIdAddressEfaLinksGet

GET /ou/{id}/addressEfaLinks

Description

Generiert den zur ID passenden Efa-Link der Adressen.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

array[EfaLink]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 53. http response codes
Code Message Datatype

200

successful operation

List[EfaLink]
Samples

ouIdExternalCompetenceDetectionGet

GET /ou/{id}/externalCompetenceDetection

Description

Es wird ausgegeben ob eine externe Organisationsermittlung verfügbar ist oder nicht.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

[Boolean]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 54. http response codes
Code Message Datatype

200

successful operation

Boolean[[boolean]]
Samples

ouIdGet

GET /ou/{id}

Description

Ermittelt eine Organisationseinheit anhand seiner Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

OrganisationalUnit

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 55. http response codes
Code Message Datatype

200

successful operation

OrganisationalUnit[OrganisationalUnit]

404

organisational unit not found

<<>>
Samples

ouIdPublicTransportationStopEfaLinksGet

GET /ou/{id}/publicTransportationStopEfaLinks

Description

Generiert den zur ID passenden Efa-Link der Haltestellen.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Organisationseinheit.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Return Type

[List]

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 56. http response codes
Code Message Datatype

200

successful operation

List[[string]]
Samples

3.6. Person

personFindGet

GET /person/find

Description

Benutzen Sie diese Funktion um Personen zu finden.

Parameters
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

searchWord

Suchwort

-

null

searchFullText

Volltextsuche

-

null

searchFuzzy

Ungenaue Suche. Standard ist 'false'

-

null

areaId

Id des Gebietes.

-

null

pstId

Id der Leistung.

-

null

ouId

Id der Organisationseinheit.

-

null

participantId

Id des Teilnehmerkreises

-

null

offset

Startindex für die Rückgabe der Ergebnisse. Wert muss > 0 sein.

-

null

limit

Maximale Anzahl von Ergebnissen.

-

null

selectAttributes

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'] [String]

-

null

sortAttribute

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'

-

null

subOrganisationalUnits

Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs

-

null
Return Type

PersonResult

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 57. http response codes
Code Message Datatype

200

successful operation

PersonResult[PersonResult]
Samples

personIdGet

GET /person/{id}

Description

Ermittelt eine Person anhand ihrer Id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Id der Person.

X

null
Header Parameters
Name Description Required Default Pattern

Accept-Language

Sprache, die verwendet werden soll

X

null
Query Parameters
Name Description Required Default Pattern

selectAttributes

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'] [String]

-

null
Return Type

Person

Content Type

  • application/json

  • text/xml

  • application/xml

Responses
Table 58. http response codes
Code Message Datatype

200

successful operation

Person[Person]

404

person not found

<<>>
Samples

4. Models

4.1. Address

Adresse

Field Name Required Nullable Type Description Format

street

String

Strasse

houseNumber

String

Hausnummer

area

NamedReference

mailbox

String

Postfach

zipcode

String

Postleitzahl

comment

String

Bemerkungen

geoLocation

GeoLocation

type

Type

descriptionLink

AddressDescriptionLink

transportationStops

List of PublicTransportationStop

Haltestellen

parkingLots

List of ParkingLot

Parkplätze

elevator

Boolean

Fahrstuhl vorhanden

wheelchairAccessible

Boolean

Barrierefreier Zugang

accessibleInfo

String

Zusätzliche Angaben zu Barrierefrei

Adresse

Field Name Required Nullable Type Description Format

link

String

Link zur Anfahrtsbeschreibung

linkTitle

String

Titel für Link zur Anfahrtsbeschreibung

4.3. BankAccount

Zahlungsdaten

Field Name Required Nullable Type Description Format

payeeName

String

Empfänger

bank

String

Kreditinstitut

IBAN

String

IBAN

BIC

String

BIC

publicVisible

Boolean

öffentlich sichtbar

publicServiceTypes

List of NamedReference

Einschränkung auf Leitungen

notes

String

Hinweise zur Verwendung

4.4. Charge

Gebühr

Field Name Required Nullable Type Description Format

type

String

Gebührentyp

restrictedArea

String

Gebiet

name

String

Bezeichnung

note

String

Bemerkung

prepayment

Boolean

Zahlung per Vorkasse möglich

currency

String

Währung

paymentNumber

String

Kassenzeichen

chargeSpecificationUrl

String

Url zur Gebührenbildung

validFrom

Date

gültig von

date-time

validTo

Date

gültig bis

date-time

amount

Double

Betrag, gefüllt wenn Typ FIX

double

upperLimit

Double

Obergrenze, gefüllt wenn Typ VARIABLE

double

lowerLimit

Double

Untergrenze, gefüllt wenn Typ VARIABLE

double

4.5. Communication

Kommunikationskanal (z.B. E-Mail, Telefon, …​)

Field Name Required Nullable Type Description Format

type

Type

title

String

Bezeichnung

note

String

Bemerkung

value

String

Wert

4.6. CommunicationSystem

Kommunikations-System

Field Name Required Nullable Type Description Format

identification

String

Kennung

identificationAddon

String

Zusatz

type

Type

4.7. ConfigParameter

Konfigurationsparameter für den OnlineService

Field Name Required Nullable Type Description Format

parameter

String

Parameter-Name

value

String

Fester Wert

selection

List of [string]

Eine von mehreren Auswahloptionen

mandatory

Boolean

Gibt an, ob der Wert gesetzt sein muss

useInUrl

Boolean

Gibt an, ob der Wert gesetzt sein muss

help

String

Eine Beschreibung des Parameters (Ausfüll-Hilfe)

type

String

Der Typ des Konfigurationsparameters: Text, Auswahl oder dynamisch(Leistungs-ID, Gebiets-ID, OE-ID, LeiKa-Schlüssel)

4.8. DeliveryChannel

Zustellungskanal eines Online-Dienstes

Field Name Required Nullable Type Description Format

channel

String

Freitext, falls kein Kontaktsystem angegeben werden kann

communicationSystem

CommunicationSystem

4.9. Department

Ressort

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

emailReceivers

String

E-Mail-Empfänger des Ressort

lastUpdated

Date

date-time

4.10. DepartmentResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of DepartmentResultEntry

4.11. DepartmentResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

Department

4.12. DirectoryPerson

Mitarbeiter aus Verzeichnis

Field Name Required Nullable Type Description Format

id

String

token

lastName

String

Nachname

firstName

String

Vorname

nameAddition

String

Zusatz

title

String

Anrede

position

String

Position

function

String

Funktion

department

String

Bereich

room

String

Raum

comment

String

addresses

List of Address

Adressen

communication

List of Communication

Kommunikationsdaten

image

List of Image

Bilder

lastUpdated

Date

date-time

anonymize

Boolean

Mitarbeiter-Daten anonymisieren

visible

Boolean

Mitarbeiter ist sichtbar

4.13. DirectoryPersonResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of DirectoryPersonResultEntry

4.14. DirectoryPersonResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

DirectoryPerson

4.15. Document

Ein- / Ausgangsdokumente zu Leistungen

Field Name Required Nullable Type Description Format

restrictedArea

String

Gebiet

direction

String

Dokumentenart (Eingangsdokument, Ausgangsdokument)

name

String

Bezeichnung

note

String

Bemerkung

validFrom

Date

gültig von

date-time

validTo

Date

gültig bis

date-time

Efa-Link zur jeweiligen Adresse

Field Name Required Nullable Type Description Format

link

String

Efa-Link zur Adresse

4.17. Form

Formular

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Bezeichnung

description

String

Beschreibung

links

List of FormLink

Downloadlinks zu den Formularen

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

publicServiceTypes

List of NamedReference

Leistungen

organisationalUnits

List of NamedReference

Organisationseinheiten

localForm

Boolean

lokales Formular

Link zum Formular um diese heruntertzuladen/anzuzeigen

Field Name Required Nullable Type Description Format

type

Type

url

String

Url

size

Long

Die Dateigröße in Bytes

int64

mimeType

String

MIME-Type

4.19. FormResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of FormResultEntry

4.20. FormResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

Form

4.21. GeoLocation

Geokoordinaten

Field Name Required Nullable Type Description Format

coordinate1

Double

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.

double

coordinate2

Double

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.

double

projection

String

Koordinatensystem der Geolokation. (EPSG:XXXXX)

4.22. Image

Bild

Field Name Required Nullable Type Description Format

mimeType

String

Bildtyp

originalFileName

String

Originaldateiname

fileSize

String

Größe

name

String

Bezeichnung

description

String

Beschreibung

source

String

Quellenkennzeichnung

url

String

Downloadurl

height

Integer

Höhe des Bildes

int32

width

Integer

Breite des Bildes

int32

4.23. Language

Sprache

Field Name Required Nullable Type Description Format

code

String

Sprach-Code

name

String

Bezeichnung

nativeName

String

Eigenbezeichung

shortName

String

Kurzbezeichung

defaultLanguage

Boolean

Standard-Sprache

4.24. NamedReference

ID und Name eines Objektes

Field Name Required Nullable Type Description Format

id

String

ID

token

name

String

Bezeichnung

4.25. OnlineAppointment

Online-Terminvereinbarung

Field Name Required Nullable Type Description Format

link

String

Link zur Online-Terminvereinbarung

configurationParameters

List of ConfigParameter

Konfigurationsparameter

4.26. OnlineService

Onlinedienst

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

öffentliche Bezeichnung

description

String

Beschreibung

link

String

Link zum Onlinedienst.

linkTitle

String

interne Bezeichnung des Onlinedienst.

image

Image

configurationParameters

List of ConfigParameter

Konfigurationsparameter

deliveryChannel

DeliveryChannel

validTo

Date

Das Datum, bis zu dem der Online-Dienst gültig ist

date-time

trustLevel

String

Das Vertrauensniveau des Online-Dienstes: NIEDRIG, SUBSTANTIELL oder HOCH

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

paymentMethods

List of Type

elektronische Zahlungsweisen

paymentProvider

NamedReference

identificationTypes

List of Type

Identifizierungsmittel

gdprText

String

Optionaler DSGVO-Hinweis

onlinePaymentRequired

String

Sagt aus ob der Bezahlvorgang Plicht(TRUE), Optional(OPTIONAL) ist oder nicht benötigt (FALSE) wird.

supportedLanguages

List of [string]

Unterstützte Sprachen des Onlinedienstes. Die Sprachcodes entsprechen RFC3066.

4.27. OnlineServiceCompetence

Zuständigkeit eines Onlinedienstes

Field Name Required Nullable Type Description Format

onlineService

NamedReference

areas

List of NamedReference

Gebiete

publicServiceTypes

List of NamedReference

Leistungen

4.28. OnlineServiceCompetenceResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OnlineServiceCompetenceResultEntry

4.29. OnlineServiceCompetenceResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OnlineServiceCompetence

4.30. OnlineServiceGroup

Onlinedienstegruppe

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

description

String

Beschreibung

onlineServices

List of NamedReference

Onlinedienste

lastUpdated

Date

date-time

4.31. OnlineServiceGroupResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OnlineServiceGroupResultEntry

4.32. OnlineServiceGroupResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OnlineServiceGroup

4.33. OnlineServiceHelp

OnlineService Hilfelink und Hilfetext

Field Name Required Nullable Type Description Format

link

String

Hilfelink des gesuchten Onlinedienstes

text

String

Hilfetext des gesuchten Onlinedienstes

4.34. OnlineServiceResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OnlineServiceResultEntry

4.35. OnlineServiceResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OnlineService

4.36. OrganisationalUnit

Organisationseinheit

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Bezeichnung

optionalName

String

Optionale OE-Kennung aus dem Redaktionssystem

synonyms

List of [string]

Synonyme der Organisationseinheit

description

String

Beschreibung

shortDescription

String

Kurzbeschreibung

parentId

String

Übergordnete Organisationseinheit

token

placename

String

Ort

generalized

Boolean

Generalisierte OE

textgeneralized

String

Ist gesetzt wenn 'generalized=true'. Hinweistext für eine Organisationseinheit die momentan nur von der Zentralredaktion angelegt wurde. 'Generalisiert'

openingHours

String

Öffnungszeiten

appointmentRequired

Boolean

Gibt an, ob zum Vorsprechen ein Termin nötig ist

onlineAppointment

OnlineAppointment

addresses

List of Address

Adressen

bankaccounts

List of BankAccount

Bankverbindungen

communications

List of Communication

misc

String

Sonstige Angaben

images

List of Image

Bilder. Das Hauptbild befindet sich an erster Stelle!

specialInfoServiceCenter

String

communicationSystems

List of CommunicationSystem

Kommunikationsmöglichkeiten

paymentMethods

List of Type

Zahlungsweisen

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

position

Long

Position der OE innerhalb der Struktur.

int64

organisationalUnitStructures

List of NamedReference

Organisationseinheit-Strukturen denen die Oragnisationseinheit zugeordnet ist.

organisationalUnitCategories

List of NamedReference

Organisationseinheit-Kategorien denen die Oragnisationseinheit zugeordnet ist.

4.37. OrganisationalUnitCategory

Oragnisationseinheitkategorie

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

description

String

Beschreibung

parentId

String

Übergeordnete Kategorie

token

organisationalUnits

List of NamedReference

Zugeordnete Organisationseinheiten

lastUpdated

Date

date-time

position

Integer

int32

4.38. OrganisationalUnitCategoryResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OrganisationalUnitCategoryResultEntry

4.39. OrganisationalUnitCategoryResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OrganisationalUnitCategory

4.40. OrganisationalUnitResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OrganisationalUnitResultEntry

4.41. OrganisationalUnitResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OrganisationalUnit

4.42. OrganisationalUnitStructure

Hierachie von Organisationseinheiten

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

title

String

Bezeichnung

description

String

Beschreibung

structure

OrganisationalUnitStructureNode

lastUpdated

Date

date-time

4.43. OrganisationalUnitStructureNode

Knoten einer Hierachie von Organisationseinheiten

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

organisationalUnit

NamedReference

description

String

Beschreibung des Hierachrieknotens

children

List of OrganisationalUnitStructureNode

untergordnete Knoten einer Hierachie von Organisationseinheiten

lastUpdated

Date

date-time

4.44. OrganisationalUnitStructureResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OrganisationalUnitStructureResultEntry

4.45. OrganisationalUnitStructureResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OrganisationalUnitStructure

4.46. OrganisationalUnitSynonym

Liste mit Synonymen die in Organisationseinheiten übernomen werden können.Diese werden nicht referenziert.

Field Name Required Nullable Type Description Format

id

String

token

name

String

lastUpdated

Date

date-time

4.47. OuCompetence

Zuständigkeit einer Organisationseinhet

Field Name Required Nullable Type Description Format

areas

List of NamedReference

Gebiete

publicServiceTypes

List of NamedReference

Leistungen

organisationalUnit

NamedReference

4.48. OuCompetenceResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of OuCompetenceResultEntry

4.49. OuCompetenceResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

OuCompetence

4.50. ParkingLot

Parkplatz

Field Name Required Nullable Type Description Format

name

String

Bezeichnung

type

Type

count

Integer

Anzahl

int32

feeApply

Boolean

Kostenpflichtig

4.51. PaymentProvider

Zahlungsdienst

Field Name Required Nullable Type Description Format

id

String

token

name

String

Bezeichnung

description

String

Beschreibung

paymentMethods

List of NamedReference

Zahlungsdienste

lastUpdated

Date

date-time

4.52. PaymentProviderResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PaymentProviderResultEntry

4.53. PaymentProviderResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

PaymentProvider

4.54. Period

Frist

Field Name Required Nullable Type Description Format

type

String

Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich)

restrictedArea

String

Gebiet

name

String

Bezeichnung

note

String

Bemerkung

validFrom

Date

gültig von

date-time

validTo

Date

gültig bis

date-time

timeSpan

Long

Zeitraum, gefüllt wenn Typ SPAN, SPANINTERVAL

int64

timeSpanTo

Long

Zeitraum,gefüllt wenn Typ SPANINTERVAL

int64

periodUnit

String

Zeitraumeinheit, gefüllt wenn Typ SPAN, SPANINTERVAL

dateFrom

Date

Datum von, gefüllt wenn Typ DATEINTERVAL

date-time

dateTo

Date

Datum bis, gefüllt wenn Typ DATEINTERVAL

date-time

PeriodRepetition

String

Wiederholung des Datumsbereiches, gefüllt wenn Typ SPAN, SPANINTERVAL

4.55. Person

Mitarbeiter

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

lastName

String

Nachname

firstName

String

Vorname

nameAddition

String

Zusatz

title

String

Anrede

position

String

Position

function

String

Funktion

department

String

Bereich

room

String

Raum

comment

String

Anmerkungen zur Person

addresses

List of Address

Adressen

communication

List of Communication

Kommunikationsdaten

image

List of Image

Bilder

competences

List of PersonCompetence

Zuständigkeiten

organisationalUnits

List of NamedReference

Organisationseinheiten

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

anonymize

Boolean

Mitarbeiter-Daten anonymisieren

visible

Boolean

Mitarbeiter ist sichtbar

4.56. PersonCompetence

Zuständigkeit eines Mitarbeiters

Field Name Required Nullable Type Description Format

areas

List of NamedReference

Gebiete

publicServiceType

NamedReference

competenceCriterias

List of [string]

Zuständigkeitskriterien

miscCriterias

List of [string]

Sonstige Kriterien

4.57. PersonResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PersonResultEntry

4.58. PersonResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

Person

4.59. PublicServiceType

Leistung

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

type

String

Leistungstyp (Leistungsobjekt (LO), Leistung mit Verrichtung (LOV), Leistung mit Verrichtung und Detail(LOVZ), Auskunft (A))

leikaKeys

List of [string]

Leikaschlüssel

name

String

Bezeichnung

teaser

String

Einleitungstext (Teiltext der gesamten Leistung)

textBlocks

List of TextBlock

Textblöcke

periods

List of Period

Fristen

servicePeriods

List of ServicePeriod

Bearbeitungsfristen

charges

List of Charge

Gebühren

documents

List of Document

Dokumente

synonyms

List of [string]

Synonyme der Leistung

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

restrictedAreas

List of NamedReference

Gebietseinschränkungen der Leistung

relatedPublicServiceTypes

List of NamedReference

Leistungen

writtenFormRequired

Boolean

Schriftform erforderlich

trustLevel

Type

sdgInformationAreas

List of Type

SDG-Informationsbereiche

receivers

List of Type

leistungsadressaten

singlePointOfContact

Boolean

Kennzeichen 'Einheitliche Stelle'

furtherPstObjectsWithActivity

List of NamedReference

Weitere LeistungsObjekte mit Verrichtung die diesem LeistungsObjekt entsprechen. (Kann nur gesetzt sein, wenn Typ geleich 'LO')'

furtherPstObjectsWithActivityAndDetail

List of NamedReference

Weitere LeistungsObjekte mit Verrichtung und Detail die diesem LeistungsObjekt entsprechen. (Kann nur gesetzt sein, wenn Typ gleich 'LO' oder 'LOV')'

department

NamedReference

4.60. PublicServiceTypeCategory

Leistungskategorie

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Bezeichnung

description

String

Beschreibung

parentId

String

Übergeordnete Kategorie

token

publicServiceTypes

List of NamedReference

Zugeordnete Leistungen

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

image

Image

pictogramCssClass

String

Beschreibung

position

Integer

int32

4.61. PublicServiceTypeCategoryResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PublicServiceTypeCategoryResultEntry

4.62. PublicServiceTypeCategoryResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

PublicServiceTypeCategory

4.63. PublicServiceTypeGroup

Leistungsgruppe

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Bezeichnung

description

String

Bezeichnung

publicServiceTypes

List of NamedReference

Leistungen

lastUpdated

Date

Letzte Aktualisierung des Objektes.

date-time

4.64. PublicServiceTypeGroupResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PublicServiceTypeGroupResultEntry

4.65. PublicServiceTypeGroupResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

PublicServiceTypeGroup

4.66. PublicServiceTypeProcess

Prozess zu einer Leistung

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Bezeichnung des Prozesses

uri

String

Url zum Prozess

referenceId

NamedReference

publicServiceType

NamedReference

type

Type

4.67. PublicServiceTypeProcessResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PublicServiceTypeProcessResultEntry

4.68. PublicServiceTypeProcessResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

PublicServiceTypeProcess

4.69. PublicServiceTypeResult

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

results

List of PublicServiceTypeResultEntry

4.70. PublicServiceTypeResultEntry

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

object

PublicServiceType

4.71. PublicTransportationLine

Linie (z.B. Buslinie)

Field Name Required Nullable Type Description Format

name

String

Bezeichnung

type

Type

4.72. PublicTransportationStop

Haltestelle

Field Name Required Nullable Type Description Format

name

String

Bezeichnung

lines

List of PublicTransportationLine

Linien (z.B. Buslinien)

4.73. Result

Ergebnis einer Suche

Field Name Required Nullable Type Description Format

count

X

Integer

Anzahl Suchtreffer

int32

totalCount

Integer

Gesamtanzahl der Suchtreffer

int32

4.74. ResultEntry

Ergebniseintrag

Field Name Required Nullable Type Description Format

score

X

Double

Wertigkeit des Suchtreffers

double

4.75. ServicePeriod

Bearbeitungsdauer

Field Name Required Nullable Type Description Format

type

String

Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich)

restrictedArea

String

Gebiet

name

String

Bezeichnung

note

String

Bemerkung

validFrom

Date

gültig von

date-time

validTo

Date

gültig bis

date-time

timeSpan

Long

Zeitraum

int64

timeSpanTo

Long

Zeitraum bis, gefüllt wenn Typ SPANINTERVAL

int64

periodUnit

String

Zeitraumeiheit

4.76. SpecialisationText

Spezialisierung eines Textblockes einer Leistung

Field Name Required Nullable Type Description Format

restrictedArea

String

Gebiet

text

String

Spezialisierter Inhalt für den Textblock

externalLinks

List of TextBlockExternalLink

Externe Links die Informationen zu dem Text enthalten.

legalNorms

List of TextBlockAdditions

Rechtsvorschriften zu der Leistung.

4.77. TextBlock

Textblock einer Leistung

Field Name Required Nullable Type Description Format

type

Type

text

String

Inhalt des Textblockes

externalLinks

List of TextBlockExternalLink

Externe Links die Informationen zu dem Text enthalten.

specialisations

List of SpecialisationText

Spezialisierungen des Textblockes

4.78. TextBlockAdditions

Addition des Textblocks Rechtsgrundlagen, hier sind die Rechtsvorschriften zu finden.

Field Name Required Nullable Type Description Format

id

String

Id der Vorschrift

name

String

Bezeichnung der Vorschrift

Externer Link für Textblockergänzung

Field Name Required Nullable Type Description Format

url

String

Url

name

String

Bezeichnung des Links

note

String

Bemerkung des Links

4.80. Type

Typ

Field Name Required Nullable Type Description Format

id

String

Id des Objektes

token

name

String

Type (z.b. PostAdress, Telefon, Stadt, etc.

description

String

Beschreibung

key

String

Schlüssel

notPublic

Boolean

öffentlich nicht sichtbarer Typ