Zuständige Behörden aktivieren und deaktivieren

authorityUpdate · federalStateUpdate · federalStateBranchUpdate

Zuständige Behörden aktivieren und deaktivieren

Dieser Use Case beschreibt die GraphQL-Funktionen für administrative Behördeneinträge.

Berechtigung

health_department:update / federal_state:update

Endpoint

POST

/api/graphql/service

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

Playground(nur GraphQL)

PRE

Rollenhinweis

Dieser Use Case ist nur für Obere Landesbehörden bzw. Benannte Stellen relevant.

GraphQL-Funktionen

Funktion	Zweck	Eingabe	Rückgabe
`authorityUpdate`	Setzt den Aktivstatus einer fachlichen Behörde.	`input: AuthorityUpdateInput!`	Ein AuthorityItem-Objekt.
`federalStateUpdate`	Setzt den Aktivstatus einer oberen Landesbehörde.	`input: FederalStateUpdateInput!`	Ein FederalStateItem-Objekt.
`federalStateBranchUpdate`	Setzt den Aktivstatus einer mittleren Landesbehörde.	`input: FederalStateBranchUpdateInput!`	Ein FederalStateBranchItem-Objekt.

authorityUpdate

Für das Aktivieren wird fields.active auf true gesetzt, für das Deaktivieren auf false. Es gibt dafür keine separate GraphQL-Mutation.

Request-Parameter

Die Badges zeigen die Nullbarkeit aus dem GraphQL-Schema. Non-null bedeutet, dass der Wert im jeweiligen Eingabeobjekt gesetzt sein muss. Nullable bedeutet, dass der Wert optional oder fachlich konditional ist.

FeldDetails

input

SchemaNon-null

TypAuthorityUpdateInput!

Eingabeobjekt für authorityUpdate. Für obere und mittlere Landesbehörden werden FederalStateUpdateInput beziehungsweise FederalStateBranchUpdateInput verwendet.

input

SchemaNon-null

TypID!

ID des Behördeneintrags.

fields

SchemaNon-null

TypAuthorityUpdateFieldsInput!

Zu ändernde Felder.

input.fields

name

SchemaNullable

TypString

Name der Behörde.

active

SchemaNullable

TypBoolean

Gibt an, ob der Registereintrag aktiv ist.

address

SchemaNullable

TypUpdateAddress

Adressänderungen.

contact

SchemaNullable

TypUpdateContact

Kontaktänderungen.

radioactiveObservations

SchemaNullable

TypBoolean

Gibt Zuständigkeit für die Überwachung radioaktiver Stoffe an.

AnfrageVariablenResponse

mutation AuthorityUpdate($input: AuthorityUpdateInput!) {
authorityUpdate(input: $input) {
  id
  name
  active
  editable
  kind
}
}

{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "active": true
  }
}
}

{
"data": {
  "authorityUpdate": {
    "id": "BY123GA801",
    "name": "API Gesundheitsamt",
    "active": true,
    "editable": true,
    "kind": "GA"
  }
}
}