1. Overview
Die ist die Dokumentation der RestApi der Infodienste. Auf der linken Seite sehen Sie das Inhaltsverzeichnis. Benutzen Sie dieses um die genauen Definitionen der Methoden und Datentypen zu erhalten. Der Zugriff auf die RestApi ist über einen ApiKey geschützt, dieser wird im Redaktionssystem der Infodienste konfiguriert.
1.2. Version
2.06.006
1.3. URI scheme
Schemes: HTTPS
1.4. Consumes
-
application/json
-
text/xml
-
application/xml
1.5. Produces
-
application/json
-
text/xml
-
application/xml
2. Resources
2.1. Allgemein
Allgemeine Resourcen wie Typen, Nationalitäten, Wirtschaftszweige, etc.
GET /types/PaymentMethod
Description
Gibt alle Zahlungsarten zurück (Kosten bei Leistungen).
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /common/economicSectors
Description
Gibt alle Wirtschaftszweige zurück. Diese können bei der Leistungssuche verwendet werden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
EconomicSector array |
GET /types/Area
Description
Gibt alle Typen für Gebiete zurück. Beinhalten geografische Gebietstypen und verwaltungspolitische Gebietstypen.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /types/Communication
Description
Gibt alle Kommunikationstypen zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /types/TextBlock
Description
Gibt alle Typen für Textblöcke zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /common/nationalities
Description
Gibt alle Nationalitäten zurück. Diese können bei der Leistungssuche verwendet werden.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Nationality array |
GET /types/GeographicalArea
Description
Gibt alle Typen für geografische Gebiete zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /common/legalForms
Description
Gibt alle Rechtsformen zurück. Diese können bei der Leistungssuche verwendet werden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
LegalForm array |
GET /common/portalLink
Description
Gibt den Link zum Portal zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
areaId |
Id des Gebietes. |
false |
integer (int64) |
|
QueryParameter |
ouId |
Id der Organisationseinheit. |
false |
integer (int64) |
|
QueryParameter |
formId |
FormularId |
false |
integer (int64) |
|
QueryParameter |
pstCatId |
Id der Leistungskategorie |
false |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
string |
404 |
object not found |
No Content |
GET /types/Address
Description
Gibt alle Adresstypen zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /types/PoliticalArea
Description
Gibt alle Typen für Politische Gebiete zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /types/PublicTransportationLine
Description
Gibt alle Verkehrsmittel-Typen zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
GET /common/languages
Description
Gibt alle Sprachen zurück.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Language array |
GET /common/onlineApplicationLink
Description
Gibt die Links zur elektronischen Antragstellung zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
areaId |
Id des Gebietes. |
false |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
TextBlockExternalLink array |
GET /types/ParkingLot
Description
Gibt alle Parkplatztypen zurück.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Type array |
404 |
class not found |
No Content |
2.2. Form
GET /form/find
Description
Benutzen Sie diese Funktion um Formulare zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
ouId |
Id der Organisationseinheit. |
false |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /form/{id}
Description
Ermittelt ein Formular anhand seiner Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id des Formulars. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
form not found |
No Content |
2.3. Gebiet
Methoden für Gebiete
GET /area/{id}
Description
Ermittelt ein Gebiet anhand seiner Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id des Gebietes. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
area not found |
No Content |
GET /area/find
Description
Benutzen Sie diese Funktion um Gebiete zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
ags |
Amtlicher Gemeindeschlüssel |
false |
string |
|
QueryParameter |
rs |
Regionalschlüssel |
false |
string |
|
QueryParameter |
className |
Typ des Gebiets ("PoliticalArea", "GeographicalArea") |
false |
string |
|
QueryParameter |
addressable |
Auf adressierbare Orte einschränken |
false |
boolean |
|
QueryParameter |
parentId |
Id des übergeordneten Objekts. |
false |
integer (int64) |
|
QueryParameter |
typeId |
Id des Types auf den die Ergebnisse eingeschränkt werden sollen. |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
2.4. Leistung
Methoden für Leistungen
GET /pst/byKey/{key}
Description
Ermittelt eine Leistung anhand des Leistungsschlüssels.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
key |
Leistungsschlüssel |
true |
string |
|
QueryParameter |
areaId |
Id des Gebietes wofür die Leistung spezialisiert werden soll. |
false |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
publicservicetype not found |
No Content |
GET /pst/byLeikaKey/{leikaKey}
Description
Ermittelt Leistungen anhand des Leika-Schlüssels.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
leikaKey |
LeikaSchlüssel der Leistung. |
true |
string |
|
QueryParameter |
areaId |
Id des Gebietes wofür die Leistungen spezialisiert werden sollen. |
false |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
GET /pstCategory/find
Description
Benutzen Sie diese Funktion um Leistungskategorien zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
parentId |
Id des übergeordneten Objekts. |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /pstGroup/{id}
Description
Ermittelt eine Leistungsgruppe anhand seiner Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Leistungsgruppe. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
group not found |
No Content |
GET /pst/{id}
Description
Ermittelt eine Leistung anhand der Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Leistung. |
true |
integer (int64) |
|
QueryParameter |
areaId |
Id des Gebietes wofür die Leistung spezialisiert werden soll. |
false |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
publicservicetype not found |
No Content |
GET /pstGroup/find
Description
Benutzen Sie diese Funktion um Leistungsgruppen zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /pstCategory/{id}
Description
Ermittelt eine Leistungskategorie anhand seiner Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Leistungskategorie. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
category not found |
No Content |
GET /pst/find
Description
Benutzen Sie diese Funktion um Leistungen zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
areaId |
Id des Gebietes. |
false |
integer (int64) |
|
QueryParameter |
pstCatId |
Id der Leistungskategorie |
false |
integer (int64) |
|
QueryParameter |
pstGroupId |
Id der Leistungsgruppe. |
false |
integer (int64) |
|
QueryParameter |
ecoSecCode |
Wirtschaftszweigcode. |
false |
string |
|
QueryParameter |
legalFormId |
Id der Rechtsform. |
false |
integer (int64) |
|
QueryParameter |
nationalityId |
Id der Nationalität. |
false |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
QueryParameter |
filterTextBlockTypes |
Einschränkung der Textblöcke die zurückgegeben weren sollen. Beispiel: ["BESCHREIBUNG", "WENWENDEN"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
2.5. Organisationseinheit
Methoden für Organisationseinheiten
GET /ou/findByArea
Description
Benutzen Sie diese Funktion um Organisationseinheiten an einem bestimmten Standort zu finden. Es werden die Orte an Adressen durchsucht.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
areaId |
Id des Gebietes des Ortes in der Adresse der Organisationseinheiten. |
true |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /ou/{id}
Description
Ermittelt eine Organisationseinheit anhand seiner Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Organisationseinheit. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
organisational unit not found |
No Content |
GET /ouCompetence/{id}
Description
Benutzen Sie diese Funktion um die Zuständigkeiten einer Organisationseinheit zu ermitteln.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Organisationseinheit. |
true |
integer (int64) |
|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
areaId |
Id des Gebietes. |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /ou/find
Description
Benutzen Sie diese Funktion um Organisationseinheiten anhand von Suchbegriffen zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
parentId |
Id des übergeordneten Objekts. |
false |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /ou/findByCompetence
Description
Benutzen Sie diese Funktion um Organisationseinheiten anhand ihrer Zuständigkeit für eine Gebiet zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
areaId |
Id des Gebietes wofür die Organisationseinheiten zuständig sind. |
true |
integer (int64) |
|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
2.6. Person
Methoden für Personen
GET /person/{id}
Description
Ermittelt eine Person anhand ihrer Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Person. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
person not found |
No Content |
GET /person/find
Description
Benutzen Sie diese Funktion um Personen zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFullText |
Volltextsuche |
false |
boolean |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
areaId |
Id des Gebietes. |
false |
integer (int64) |
|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
ouId |
Id der Organisationseinheit. |
false |
integer (int64) |
|
QueryParameter |
participantId |
Id des Teilnehmerkreises |
false |
integer (int64) |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
QueryParameter |
subOrganisationalUnits |
Suche nicht nur für die angegebene OE, sondern auch in allen Unter-OEs |
false |
boolean |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
2.7. VHK
Methoden für Vorhabensklärung
GET /profession/find
Description
Benutzen Sie diese Funktion um Tätigkeiten zu finden.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
QueryParameter |
searchWord |
Suchwort |
false |
string |
|
QueryParameter |
searchFuzzy |
Ungenaue Suche. Standard ist 'false' |
false |
boolean |
|
QueryParameter |
searchNamePrefix |
Suche nach Wortanfang des Namens des Objektes. Z.B. Anfangsbuchstaben einer Tätigkeitsbezeichnung. |
false |
string |
|
QueryParameter |
pstId |
Id der Leistung. |
false |
integer (int64) |
|
QueryParameter |
ecoSecCode |
Wirtschaftszweigcode. |
false |
string |
|
QueryParameter |
ecoSecCatKey |
Wirtschaftszweigkartegorieschlüssel |
false |
string |
|
QueryParameter |
offset |
Startindex für die Rückgabe der Ergebnisse. |
false |
integer (int32) |
|
QueryParameter |
limit |
Maximale Anzahl von Ergebnissen. |
false |
integer (int32) |
|
QueryParameter |
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"] |
false |
multi string array |
|
QueryParameter |
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' |
false |
string |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request has succeeded |
GET /profession/{id}
Description
Ermittelt eine Tätigkeit anhand der Id.
Parameters
Type | Name | Description | Required | Schema | Default |
---|---|---|---|---|---|
PathParameter |
id |
Id der Tätigkeit. |
true |
integer (int64) |
|
QueryParameter |
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"] |
false |
multi string array |
|
HeaderParameter |
Accept-Language |
Sprache, die verwendet werden soll |
true |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
|
404 |
profession not found |
No Content |
3. Definitions
3.1. Address
Adresse
Name | Description | Required | Schema | Default |
---|---|---|---|---|
street |
Strasse |
false |
string |
|
houseNumber |
Hausnummer |
false |
string |
|
city |
Ort |
false |
string |
|
mailbox |
Postfach |
false |
string |
|
zipcode |
Postleitzahl |
false |
string |
|
comment |
Bemerkungen |
false |
string |
|
geoLocation |
false |
|||
type |
false |
3.2. Area
Gebiet
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
ags |
Gemeindenummer |
false |
string |
|
rs |
Regionalschlüssel |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
shortName |
Kurzbezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
parentId |
Übergeordnetes Gebiet |
false |
integer (int64) |
|
areaType |
false |
|||
areaClass |
false |
|||
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.3. AreaClass
Gebietsklasse (z.B. Politisches Gebiet, Geographisches Gebiet)
Name | Description | Required | Schema | Default |
---|---|---|---|---|
key |
Schlüssel |
false |
string |
|
name |
Bezeichnung |
false |
string |
3.4. AreaResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
AreaResultEntry array |
3.5. AreaResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.6. BankAccount
Zahlungsdaten
Name | Description | Required | Schema | Default |
---|---|---|---|---|
payeeName |
Empfänger |
false |
string |
|
accountNumber |
Kontonummer |
false |
string |
|
bankCode |
Bankleitzahl |
false |
string |
|
bank |
Kreditinstitut |
false |
string |
|
IBAN |
IBAN |
false |
string |
|
BIC |
BIC |
false |
string |
|
publicVisible |
öffentlich sichtbar |
false |
boolean |
|
publicServiceTypes |
Einschränkung auf Leitungen |
false |
NamedReference array |
3.7. Charge
Gebühr
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type |
Gebührentyp |
false |
string |
|
rectrictedArea |
Gebiet |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
paymentMethods |
Zahlungsweisen |
false |
Type array |
|
prepayment |
Zahlung per Vorkasse möglich |
false |
boolean |
|
currency |
Währung |
false |
string |
|
paymentNumber |
Kassenzeichen |
false |
string |
|
chargeSpecificationUrl |
Url zur Gebührenbildung |
false |
string |
|
validFrom |
gültig von |
false |
string (date-time) |
|
validTo |
gültig bis |
false |
string (date-time) |
|
amount |
Betrag, gefüllt wenn Typ FIX |
false |
number (double) |
|
upperLimit |
Obergrenze, gefüllt wenn Typ VARIABLE |
false |
number (double) |
|
lowerLimit |
Untergrenze, gefüllt wenn Typ VARIABLE |
false |
number (double) |
3.8. Communication
Kommunikationskanal (z.B. E-Mail, Telefon, …)
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type |
false |
|||
title |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
value |
Wert |
false |
string |
3.9. CommunicationSystem
Kommunikations-System
Name | Description | Required | Schema | Default |
---|---|---|---|---|
identification |
Kennung |
false |
string |
|
identificationAddon |
Zusatz |
false |
string |
|
type |
false |
3.10. Document
Ein- / Ausgangsdokumente zu Leistungen
Name | Description | Required | Schema | Default |
---|---|---|---|---|
rectrictedArea |
Gebiet |
false |
string |
|
direction |
Dokumentenart (Eingangsdokument, Ausgangsdokument) |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
validFrom |
gültig von |
false |
string (date-time) |
|
validTo |
gültig bis |
false |
string (date-time) |
3.11. EconomicSector
Wirtschaftszweig
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name |
Bezeichnung |
false |
string |
|
part |
Abschnitt |
false |
string |
|
code |
WZ Kode |
false |
string |
|
isic |
ISIC |
false |
string |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.12. Form
Formular
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
links |
Downloadlinks zu den Formularen |
false |
FormLink array |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
|
publicServiceTypes |
Leistungen |
false |
NamedReference array |
3.13. FormLink
Link zum Formular um diese heruntertzuladen/anzuzeigen
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type |
false |
|||
url |
Url |
false |
string |
|
size |
Die Dateigröße in Bytes |
false |
integer (int64) |
|
mimeType |
MIME-Type |
false |
string |
3.14. FormResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
FormResultEntry array |
3.15. FormResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.16. GeoLocation
Geokoordinaten
Name | Description | Required | Schema | Default |
---|---|---|---|---|
coordinate1 |
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. |
false |
number (double) |
|
coordinate2 |
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. |
false |
number (double) |
|
projection |
Koordinatensystem der Geolokation. (EPSG:XXXXX) |
false |
string |
3.17. Image
Bild
Name | Description | Required | Schema | Default |
---|---|---|---|---|
mimeType |
Bildtyp |
false |
string |
|
originalFileName |
Originaldateiname |
false |
string |
|
fileSize |
Größe |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
source |
Quellenkennzeichnung |
false |
string |
|
url |
Downloadurl |
false |
string |
|
height |
Höhe des Bildes |
false |
integer (int32) |
|
width |
Breite des Bildes |
false |
integer (int32) |
3.18. Language
Sprache
Name | Description | Required | Schema | Default |
---|---|---|---|---|
code |
Sprach-Code |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
nativeName |
Eigenbezeichung |
false |
string |
|
shortName |
Kurzbezeichung |
false |
string |
|
defaultLanguage |
Standard-Sprache |
false |
boolean |
3.19. LegalForm
Rechtsform
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
key |
Schlüssel |
false |
string |
|
parentId |
Übergeordnete Rechtsform |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.20. NamedReference
ID und Name eines Objektes
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
ID |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
3.21. Nationality
Staatangehörigkeit
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
key |
Schlüssel |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.22. OrganisationalUnit
Organisationseinheit
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
shortDescription |
Kurzbeschreibung |
false |
string |
|
parentId |
Übergordnete Organisationseinheit |
false |
integer (int64) |
|
placename |
Ort |
false |
string |
|
generalized |
Generalisierte OE |
false |
boolean |
|
textgeneralized |
Ist geseetzt wenn 'generalized=true'. Hinweistext für eine Organisationseinheit die momentan nur von der Zentralredaktion angelegt wurde. (Generalisiert) |
false |
string |
|
openingHours |
Öffnungszeiten |
false |
string |
|
transportationStops |
Haltestellen |
false |
PublicTransportationStop array |
|
parkingLots |
Parkplätze |
false |
ParkingLot array |
|
addresses |
Adressen |
false |
Address array |
|
bankaccounts |
Bankverbindungen |
false |
BankAccount array |
|
communications |
false |
Communication array |
||
misc |
Sonstige Angaben |
false |
string |
|
images |
Bilder. Das Hauptbild befindet sich an erster Stelle! |
false |
Image array |
|
specialInfoServiceCenter |
false |
string |
||
communicationSystems |
Kommunikationsmöglichkeiten |
false |
CommunicationSystem array |
|
elevator |
Fahrstuhl vorhanden |
false |
boolean |
|
wheelchairAccessible |
Barrierefreier Zugang |
false |
boolean |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.23. OrganisationalUnitResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
3.24. OrganisationalUnitResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.25. OuCompetence
Zuständigkeit einer Organisationseinhet
Name | Description | Required | Schema | Default |
---|---|---|---|---|
areas |
Gebiete |
false |
NamedReference array |
|
publicServiceTypes |
Leistungen |
false |
NamedReference array |
3.26. OuCompetenceResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
OuCompetenceResultEntry array |
3.27. OuCompetenceResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.28. ParkingLot
Parkplatz
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name |
Bezeichnung |
false |
string |
|
type |
false |
|||
count |
Anzahl |
false |
integer (int32) |
|
feeApply |
Kostenpflichtig |
false |
boolean |
3.29. Period
Frist
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type |
Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich) |
false |
string |
|
rectrictedArea |
Gebiet |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
validFrom |
gültig von |
false |
string (date-time) |
|
validTo |
gültig bis |
false |
string (date-time) |
|
timeSpan |
Zeitraum, gefüllt wenn Typ SPAN, SPANINTERVAL |
false |
integer (int64) |
|
timeSpanTo |
Zeitraum,gefüllt wenn Typ SPANINTERVAL |
false |
integer (int64) |
|
periodUnit |
Zeitraumeinheit, gefüllt wenn Typ SPAN, SPANINTERVAL |
false |
string |
|
dateFrom |
Datum von, gefüllt wenn Typ DATEINTERVAL |
false |
string (date-time) |
|
dateTo |
Datum bis, gefüllt wenn Typ DATEINTERVAL |
false |
string (date-time) |
|
PeriodRepetition |
Wiederholung des Datumsbereiches, gefüllt wenn Typ SPAN, SPANINTERVAL |
false |
string |
3.30. Person
Mitarbeiter
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
lastName |
Nachname |
false |
string |
|
firstName |
Vorname |
false |
string |
|
nameAddition |
Zusatz |
false |
string |
|
title |
Anrede |
false |
string |
|
position |
Position |
false |
string |
|
function |
Funktion |
false |
string |
|
department |
Bereich |
false |
string |
|
room |
Raum |
false |
string |
|
comment |
Anmerkungen zur Person |
false |
string |
|
addresses |
Adressen |
false |
Address array |
|
communication |
Kommunikationsdaten |
false |
Communication array |
|
image |
Bilder |
false |
Image array |
|
competences |
Zuständigkeiten |
false |
PersonCompetence array |
|
organisationalUnits |
Organisationseinheiten |
false |
NamedReference array |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.31. PersonCompetence
Zuständigkeit eines Mitarbeiters
Name | Description | Required | Schema | Default |
---|---|---|---|---|
areas |
Gebiete |
false |
NamedReference array |
|
publicServiceType |
false |
|||
competenceCriterias |
Zuständigkeitskriterien |
false |
string array |
|
miscCriterias |
Sonstige Kriterien |
false |
string array |
3.32. PersonResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
PersonResultEntry array |
3.33. PersonResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.34. Profession
Tätigkeit
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
regulated |
Kennzeichen für Reglementierte Tätigkeit |
false |
boolean |
|
publicServiceTypesEaPrimary |
EA Leistungen |
false |
NamedReference array |
|
publicServiceTypesEaSecondary |
EA Leistungen (nachrangig) |
false |
NamedReference array |
|
publicServiceTypesInformation |
Informationen |
false |
NamedReference array |
|
publicServiceTypesExternal |
Externe Leistungen |
false |
NamedReference array |
3.35. ProfessionResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
ProfessionResultEntry array |
3.36. ProfessionResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.37. PublicServiceType
Leistung
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
type |
Leistungstyp (Leistungsobjekt, Leistung mit Verrichtung, Leistung mit Verrichtung und Detail) |
false |
string |
|
pstKey |
Leistungsschlüssel |
false |
string |
|
leikaKeys |
Leikaschlüssel |
false |
string array |
|
name |
Bezeichnung |
false |
string |
|
teaser |
Einleitungstext (Teiltext der gesamten Leistung) |
false |
string |
|
textBlocks |
Textblöcke |
false |
TextBlock array |
|
periods |
Fristen |
false |
Period array |
|
servicePeriods |
Bearbeitungsfristen |
false |
ServicePeriod array |
|
charges |
Gebühren |
false |
Charge array |
|
documents |
Dokumente |
false |
Document array |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.38. PublicServiceTypeCategory
Leistungskategorie
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
description |
Beschreibung |
false |
string |
|
parentId |
Übergeordnete Kategorie |
false |
integer (int64) |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.39. PublicServiceTypeCategoryResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
3.40. PublicServiceTypeCategoryResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.41. PublicServiceTypeGroup
Leistungsgruppe
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Bezeichnung |
false |
string |
|
description |
Bezeichnung |
false |
string |
|
publicServiceTypes |
Leistungen |
false |
NamedReference array |
|
lastUpdated |
Letzte Aktualisierung des Objektes. |
false |
string (date-time) |
3.42. PublicServiceTypeGroupResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
3.43. PublicServiceTypeGroupResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.44. PublicServiceTypeResult
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
|
results |
false |
3.45. PublicServiceTypeResultEntry
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
|
object |
false |
3.46. PublicTransportationLine
Linie (z.B. Buslinie)
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name |
Bezeichnung |
false |
string |
|
type |
false |
3.47. PublicTransportationStop
Haltestelle
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name |
Bezeichnung |
false |
string |
|
lines |
Linien (z.B. Buslinien) |
false |
PublicTransportationLine array |
3.48. Result
Ergebnis einer Suche
Name | Description | Required | Schema | Default |
---|---|---|---|---|
count |
Anzahl Suchtreffer |
true |
integer (int32) |
3.49. ResultEntry
Ergebniseintrag
Name | Description | Required | Schema | Default |
---|---|---|---|---|
score |
Wertigkeit des Suchtreffers |
true |
number (double) |
3.50. ServicePeriod
Bearbeitungsdauer
Name | Description | Required | Schema | Default |
---|---|---|---|---|
type |
Fristart (Zeitraum, variabler Zeitraum, fester Datumsbereich) |
false |
string |
|
rectrictedArea |
Gebiet |
false |
string |
|
name |
Bezeichnung |
false |
string |
|
note |
Bemerkung |
false |
string |
|
validFrom |
gültig von |
false |
string (date-time) |
|
validTo |
gültig bis |
false |
string (date-time) |
|
timeSpan |
Zeitraum |
false |
integer (int64) |
|
timeSpanTo |
Zeitraum bis, gefüllt wenn Typ SPANINTERVAL |
false |
integer (int64) |
|
periodUnit |
Zeitraumeiheit |
false |
string |
3.51. SpecialisationText
Spezialisierung eines Textblockes einer Leistung
Name | Description | Required | Schema | Default |
---|---|---|---|---|
rectrictedArea |
Gebiet |
false |
string |
|
text |
Spezialisierter Inhalt für den Textblock |
false |
string |
|
externalLinks |
Externe Links die Informationen zu dem Text enthalten. |
false |
TextBlockExternalLink array |
3.52. TextBlock
Textblock einer Leistung
Name | Description | Required | Schema | Default |
---|---|---|---|---|
name |
Name des Textblockes |
false |
string |
|
type |
false |
|||
text |
Inhalt des Textblockes |
false |
string |
|
externalLinks |
Externe Links die Informationen zu dem Text enthalten. |
false |
TextBlockExternalLink array |
|
specialisations |
Spezialisierungen des Textblockes |
false |
SpecialisationText array |
3.53. TextBlockExternalLink
Externer Link für Textblockergänzung
Name | Description | Required | Schema | Default |
---|---|---|---|---|
url |
Url |
false |
string |
|
name |
Bezeichnung des Links |
false |
string |
|
note |
Bemerkung des Links |
false |
string |
3.54. Type
Typ
Name | Description | Required | Schema | Default |
---|---|---|---|---|
id |
Id des Objektes |
false |
integer (int64) |
|
name |
Type (z.b. PostAdress, Telefon, Stadt, etc. |
false |
string |
|
description |
Beschreibung |
false |
string |
|
key |
Schlüssel |
false |
string |
|
notPublic |
öffentlich nicht sichtbarer Typ |
false |
boolean |