SHAPTH
Use Case
authorityUpdate · federalStateUpdate · federalStateBranchUpdate

Zuständige Behörden bearbeiten

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

GraphQL-Funktionen

FunktionZweckEingabeRückgabe
authorityUpdateBearbeitet eine fachliche Behörde.input: AuthorityUpdateInput!Ein AuthorityItem-Objekt.
federalStateUpdateBearbeitet eine obere Landesbehörde.input: FederalStateUpdateInput!Ein FederalStateItem-Objekt.
federalStateBranchUpdateBearbeitet eine mittlere Landesbehörde.input: FederalStateBranchUpdateInput!Ein FederalStateBranchItem-Objekt.

authorityUpdate

Für Bearbeitungen wird je nach Behördenart die passende Update-Mutation genutzt.

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
id
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.
input.fields.address
street
SchemaNullable
TypString
Straße.
house
SchemaNullable
TypString
Hausnummer.
zip
SchemaNullable
TypString
Postleitzahl.
place
SchemaNullable
TypString
Ort.
additional
SchemaNullable
TypString
Adresszusatz.
input.fields
contact
SchemaNullable
TypUpdateContact
Kontaktänderungen.
input.fields.contact
mailbox
SchemaNullable
TypString
Funktionspostfach.
email
SchemaNullable
Typ[String!]
E-Mail-Adressen.
phone
SchemaNullable
Typ[String!]
Telefonnummern.
comment
SchemaNullable
TypString
Kontaktkommentar.
website
SchemaNullable
Typ[String!]
Webseiten.
input.fields
radioactiveObservations
SchemaNullable
TypBoolean
Gibt Zuständigkeit für die Überwachung radioaktiver Stoffe an.
mutation AuthorityUpdate($input: AuthorityUpdateInput!) {
authorityUpdate(input: $input) {
  id
  name
  active
  editable
  kind
}
}
{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "name": "API Gesundheitsamt aktualisiert"
  }
}
}
{
"data": {
  "authorityUpdate": {
    "id": "BY123GA801",
    "name": "API Gesundheitsamt aktualisiert",
    "active": true,
    "editable": true,
    "kind": "GA"
  }
}
}

On this page

GraphQL-FunktionenauthorityUpdate