SHAPTH
Use Case
authorityCreate

Zuständige Behörden erstellen

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

Berechtigunghealth_department:manage
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE
i
Rollenhinweis

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

authorityCreate

Für das Erstellen fachlicher Behörden wird authorityCreate verwendet. Obere und mittlere Landesbehörden haben im vorliegenden Schema keine Create-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
TypAuthorityCreateInput!
Eingabeobjekt für authorityCreate.
input
circleKey
SchemaNon-null
TypString!
Amtlicher Kreisschlüssel beziehungsweise Gebietsschlüssel.
Hinweis zum circleKey
Der circleKey leitet sich aus dem amtlichen Landkreisschlüssel des Sitzes der Behörde ab. Die ersten beiden Ziffern werden dabei durch das jeweilige Bundesland-Kürzel ersetzt.
Beispiel: Aus dem Landkreisschlüssel 09180 für Garmisch-Partenkirchen wird BY180, da 09 für Bayern durch BY ersetzt wird.
kind
SchemaNon-null
TypCreateAuthorityKind!
Behördenart. Erlaubt sind GA, WA und SO.
fields
SchemaNon-null
TypAuthorityCreateFieldsInput!
Fachliche Stammdaten.
input.fields
name
SchemaNon-null
TypString!
Name der Behörde.
address
SchemaNon-null
TypCreateAddress!
Adresse des Eintrags.
input.fields.address
street
SchemaNon-null
TypString!
Straße.
house
SchemaNon-null
TypString!
Hausnummer.
zip
SchemaNon-null
TypString!
Postleitzahl.
place
SchemaNon-null
TypString!
Ort.
additional
SchemaNullable
TypString
Adresszusatz.
state
SchemaNon-null
TypString!
Bundesland oder Staat.
input.fields
contact
SchemaNon-null
TypCreateContact!
Kontaktinformationen.
input.fields.contact
mailbox
SchemaNullable
TypString
Funktionspostfach.
email
SchemaNon-null
Typ[String!]!
E-Mail-Adressen.
phone
SchemaNon-null
Typ[String!]!
Telefonnummern.
website
SchemaNon-null
Typ[String!]!
Webseiten.
comment
SchemaNullable
TypString
Kontaktkommentar.
input.fields
radioactiveObservations
SchemaNullable
TypBoolean
Gibt Zuständigkeit für die Überwachung radioaktiver Stoffe an.
mutation AuthorityCreate($input: AuthorityCreateInput!) {
authorityCreate(input: $input) {
  id
  name
  address {
    street
    house
    zip
    place
    additional
    state
  }
  contact {
    mailbox
    email
    phone
    website
    comment
  }
  radioactiveObservations
  active
  editable
  kind
}
}
{
"input": {
  "circleKey": "BY162",
  "kind": "GA",
  "fields": {
    "name": "API Gesundheitsamt",
    "address": {
      "street": "Musterstraße",
      "house": "1",
      "zip": "80331",
      "place": "München",
      "additional": "Zimmer 101",
      "state": "BY"
    },
    "contact": {
      "mailbox": "Postfach 456",
      "email": ["poststelle@example.org"],
      "phone": ["+49 89 123456"],
      "website": ["https://example.org"],
      "comment": "Zentrale Kontaktadresse"
    },
    "radioactiveObservations": false
  }
}
}
{
"data": {
  "authorityCreate": {
    "id": "BY123GA801",
    "name": "API Gesundheitsamt",
    "address": {
      "street": "Musterstraße",
      "house": "1",
      "zip": "80331",
      "place": "München",
      "additional": "Zimmer 101",
      "state": "BY"
    },
    "contact": {
      "mailbox": "Postfach 456",
      "email": ["poststelle@example.org"],
      "phone": ["+49 89 123456"],
      "website": ["https://example.org"],
      "comment": "Zentrale Kontaktadresse"
    },
    "radioactiveObservations": false,
    "active": true,
    "editable": true,
    "kind": "GA"
  }
}
}

GraphQL-Enums

CreateAuthorityKind

Beschreibt die erlaubten Behördenarten beim Erstellen einer fachlichen Behörde über authorityCreate.

WertBedeutung
GAGesundheitsamt
WAWasseramt
SOSonstige Behörde

On this page

authorityCreateGraphQL-Enums