SHAPTH
Use Case
officialList · authorityList · federalStateList · federalStateBranchList

Zuständige Behörden abrufen

Das folgende Beispiel zeigt den GraphQL-Abruf zuständiger Behörden, die im Administrationsregister geführt werden. Die Abfrage eignet sich für API-Anbindungen, wenn Behördeninformationen angezeigt, referenziert oder für die Zuordnung in Register-Workflows genutzt werden sollen.

Berechtigung
health_department:view / federal_state:view / federal_state_branch:view
Endpoint
POST
/api/graphql/service

Weitere Informationen zu Basis-URLs und Umgebungen stehen im Kapitel Endpunkte.

Playground(nur GraphQL)
PRE

Welche Abfrage wann?

AbfrageZweckEingabeRückgabe
officialListBreite Behördenliste abrufen. Die Liste enthält obere Landesbehörden, mittlere Landesbehörden und Gesundheitsämter.input: OfficialListInput. In diesem Beispiel wird nur pagination verwendet.Liste unter items und Gesamtzahl unter total.
authorityListFachlich zuständige Behörden abrufen. Die Liste enthält Gesundheitsämter, Wasserämter und sonstige Behörden.input: AuthorityListInput. In diesem Beispiel wird nur pagination verwendet.Liste unter items und Gesamtzahl unter total.
federalStateListNur obere Landesbehörden abrufen.input: FederalStateListInput. In diesem Beispiel wird nur pagination verwendet.Liste unter items und Gesamtzahl unter total.
federalStateBranchListNur mittlere Landesbehörden abrufen.input: FederalStateBranchListInput. In diesem Beispiel wird nur pagination verwendet.Liste unter items und Gesamtzahl unter total.
officialByIdEine einzelne Behörde anhand ihrer id abrufen.id: ID!.Ein OfficialItem.

Hinweis: officialById ist hier ein Beispiel für das ById-Muster. Nach demselben Prinzip können auch andere Listenabfragen einen zugehörigen ById-Abruf besitzen, sofern die jeweilige Funktion im GraphQL-Schema bereitgestellt wird.

officialList

officialList eignet sich für Übersichten und Trefferlisten, wenn alle Behördenarten gemeinsam betrachtet werden sollen. Die Abfrage enthält nach der aktuellen fachlichen Trennung obere Landesbehörden, mittlere Landesbehörden und Gesundheitsämter. Allgemeine Listenfunktionen wie Pagination, Suche, Filterung und Sortierung werden zentral im Kapitel GraphQL-Variablen und Listenabfragen beschrieben.

Objektstruktur und Felder

Die folgende Feldliste dokumentiert die gemeinsame Behördenstruktur, die in den Listen unter items zurückgegeben wird.

FeldDetails
input
SchemaNullable
TypOfficialListInput
Optionale Eingabe für die Listenabfrage. Das generische Muster mit `pagination`, `search`, `filter` und `sort` ist im allgemeinen GraphQL-Kapitel beschrieben.
total
SchemaNon-null
TypInt!
Gesamtzahl der zur Abfrage passenden zuständigen Behörden.
items
SchemaNon-null
Typ[OfficialItem!]!
Liste der gefundenen zuständigen Behörden.
items
r
SchemaNon-null
TypID!
Technische Referenz-ID der Behörde.
id
SchemaNon-null
TypID!
Eindeutige ID der Behörde. Diese ID wird für `officialById` verwendet.
name
SchemaNullable
TypString
Name der Behörde.
active
SchemaNon-null
TypBoolean!
Gibt an, ob der Registereintrag aktiv ist.
editable
SchemaNullable
TypBoolean
Gibt an, ob der Eintrag durch den angebundenen Akteur bearbeitet werden kann.
kind
SchemaNullable
TypAuthorityKind
Art der Behörde. Die möglichen Werte stehen unten bei den GraphQL-Enums.
address
SchemaNon-null
TypAddress!
Adresse der Behörde.
items.address
text
SchemaNullable
TypString
Formatierte Adresse als Text.
street
SchemaNullable
TypString
Straße.
house
SchemaNullable
TypString
Hausnummer.
zip
SchemaNullable
TypString
Postleitzahl.
place
SchemaNullable
TypString
Ort.
additional
SchemaNullable
TypString
Adresszusatz.
state
SchemaNullable
TypString
Bundesland oder Staat.
items
contact
SchemaNon-null
TypContact!
Kontaktinformationen der Behörde.
items.contact
mailbox
SchemaNullable
TypString
Funktionspostfach.
email
SchemaNullable
Typ[String!]
E-Mail-Adressen.
phone
SchemaNullable
Typ[String!]
Telefonnummern.
website
SchemaNullable
Typ[String!]
Webseiten.
items
radioactiveObservations
SchemaNullable
TypBoolean
Gibt Zuständigkeit für die Überwachung radioaktiver Stoffe an.
readRights
SchemaNullable
TypBoolean
Gibt an, ob Leserechte auf den Eintrag bestehen.
query OfficialList($input: OfficialListInput) {
officialList(input: $input) {
  total
  items {
    r
    id
    name
    active
    editable
    kind
    address {
      text
      street
      house
      zip
      place
      additional
      state
    }
    contact {
      mailbox
      email
      phone
      website
    }
    radioactiveObservations
    readRights
  }
}
}
{
"input": {
  "pagination": {
    "page": 0,
    "limit": 10
  }
}
}
{
"data": {
  "officialList": {
    "total": 1,
    "items": [
      {
        "r": "R092901B140EF8706000",
        "id": "BY123GA801",
        "name": "Muster Gesundheitsamt",
        "active": true,
        "editable": false,
        "kind": "GA",
        "address": {
          "text": "Musterstraße 1, 80331 München",
          "street": "Musterstraße",
          "house": "1",
          "zip": "80331",
          "place": "München",
          "additional": null,
          "state": "BY"
        },
        "contact": {
          "mailbox": "poststelle@example.org",
          "email": ["poststelle@example.org"],
          "phone": ["+49 89 123456"],
          "website": ["https://example.org"]
        },
        "radioactiveObservations": false,
        "readRights": true
      }
    ]
  }
}
}

authorityList

authorityList ist die fachlich enger gefasste Behördenliste. Sie liefert Gesundheitsämter, Wasserämter und sonstige Behörden.

Abgrenzung

Berechtigung
health_department:view
Behördenarten
GA GesundheitsamtWA WasseramtSO Sonstige Behörde
Rückgabestruktur
Entspricht der oben dokumentierten gemeinsamen Behördenstruktur.
query AuthorityList($input: AuthorityListInput) {
authorityList(input: $input) {
  total
  items {
    r
    id
    name
    active
    editable
    kind
    address { text street house zip place additional state }
    contact { mailbox email phone website }
    radioactiveObservations
    readRights
  }
}
}
{
"input": {
  "pagination": {
    "page": 0,
    "limit": 10
  }
}
}
{
"data": {
  "authorityList": {
    "total": 1,
    "items": [
      {
        "r": "R092901B140EF8706000",
        "id": "BY123GA801",
        "name": "Muster Gesundheitsamt",
        "active": true,
        "editable": false,
        "kind": "GA",
        "address": {
          "text": "Musterstraße 1, 80331 München",
          "street": "Musterstraße",
          "house": "1",
          "zip": "80331",
          "place": "München",
          "additional": null,
          "state": "BY"
        },
        "contact": {
          "mailbox": "poststelle@example.org",
          "email": ["poststelle@example.org"],
          "phone": ["+49 89 123456"],
          "website": ["https://example.org"]
        },
        "radioactiveObservations": false,
        "readRights": true
      }
    ]
  }
}
}

federalStateList

federalStateList liefert ausschließlich obere Landesbehörden.

Abgrenzung

Berechtigung
federal_state:view
Behördenart
OB Obere Landesbehörde
Rückgabestruktur
Entspricht der oben dokumentierten gemeinsamen Behördenstruktur.
query FederalStateList($input: FederalStateListInput) {
federalStateList(input: $input) {
  total
  items {
    r
    id
    name
    active
    editable
    kind
    address { text street house zip place additional state }
    contact { mailbox email phone website }
    radioactiveObservations
    readRights
  }
}
}
{
"input": {
  "pagination": {
    "page": 0,
    "limit": 10
  }
}
}
{
"data": {
  "federalStateList": {
    "total": 1,
    "items": [
      {
        "r": "R092901B140EF8706100",
        "id": "BY-OB-0001",
        "name": "Obere Landesbehörde Beispiel",
        "active": true,
        "editable": false,
        "kind": "OB",
        "address": {
          "text": "Behördenplatz 1, 80331 München",
          "street": "Behördenplatz",
          "house": "1",
          "zip": "80331",
          "place": "München",
          "additional": null,
          "state": "BY"
        },
        "contact": {
          "mailbox": "poststelle@example.org",
          "email": ["poststelle@example.org"],
          "phone": ["+49 89 123456"],
          "website": ["https://example.org"]
        },
        "radioactiveObservations": false,
        "readRights": true
      }
    ]
  }
}
}

federalStateBranchList

federalStateBranchList liefert ausschließlich mittlere Landesbehörden.

Abgrenzung

Berechtigung
federal_state_branch:view
Behördenart
MB Mittlere Landesbehörde
Rückgabestruktur
Entspricht der oben dokumentierten gemeinsamen Behördenstruktur.
query FederalStateBranchList($input: FederalStateBranchListInput) {
federalStateBranchList(input: $input) {
  total
  items {
    r
    id
    name
    active
    editable
    kind
    address { text street house zip place additional state }
    contact { mailbox email phone website }
    radioactiveObservations
    readRights
  }
}
}
{
"input": {
  "pagination": {
    "page": 0,
    "limit": 10
  }
}
}
{
"data": {
  "federalStateBranchList": {
    "total": 1,
    "items": [
      {
        "r": "R092901B140EF8706200",
        "id": "BY-MB-0001",
        "name": "Mittlere Landesbehörde Beispiel",
        "active": true,
        "editable": false,
        "kind": "MB",
        "address": {
          "text": "Regierungsstraße 1, 80331 München",
          "street": "Regierungsstraße",
          "house": "1",
          "zip": "80331",
          "place": "München",
          "additional": null,
          "state": "BY"
        },
        "contact": {
          "mailbox": "poststelle@example.org",
          "email": ["poststelle@example.org"],
          "phone": ["+49 89 123456"],
          "website": ["https://example.org"]
        },
        "radioactiveObservations": false,
        "readRights": true
      }
    ]
  }
}
}

officialById

officialById wird verwendet, wenn die ID einer zuständigen Behörde bereits bekannt ist. Die ID stammt typischerweise aus officialList.items.id.

Parameter

FeldDetails
id
SchemaNon-null
TypID!
Eindeutige ID der zuständigen Behörde.
query OfficialById($id: ID!) {
officialById(id: $id) {
  r
  id
  name
  active
  editable
  kind
  address { text street house zip place additional state }
  contact { mailbox email phone website }
  radioactiveObservations
  readRights
}
}
{
"id": "<DUMMY-SHAPTH-ID>"
}

GraphQL-Enums

Die Behördenart wird hier nicht über eine XWasser-Codeliste gepflegt, sondern über das GraphQL-Enum AuthorityKind. Deshalb gibt es auf dieser Seite keinen XWasser-Code-Verweis.

AuthorityKind

WertBedeutung
OBObere Landesbehörde
MBMittlere Landesbehörde
GAGesundheitsamt
WAWasseramt
SOSonstige Behörde

Such- und Sortier-Enums

EnumWerteEinsatz
OfficialSearchFieldID, NAME, ADDRESSSuchfelder für input.search.fields.
OfficialSortFieldID, NAME, ADDRESS, STREET, HOUSE, ZIP, PLACE, CREATED_AT, CREATED_BY, UPDATED_AT, UPDATED_BYSortierfelder für input.sort.by.
SortOrderASC, DESCSortierreihenfolge für input.sort.order.

On this page

Welche Abfrage wann?officialListauthorityListfederalStateListfederalStateBranchListofficialByIdGraphQL-EnumsAuthorityKindSuch- und Sortier-Enums