SHAPTH
Use Case
wsAreaUpdate

Wasserversorgungsgebiete bearbeiten

Dieser Use Case beschreibt das Bearbeiten vorhandener Wasserversorgungsgebiete.

Berechtigungws_area:manage
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE

wsAreaUpdate

Es werden nur die Felder geändert, die im Objekt fields gesetzt sind. Nicht gesetzte Felder bleiben unverändert.

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
TypWsAreaUpdateInput!
Eingabeobjekt für wsAreaUpdate.
input
id
SchemaNon-null
TypID!
ID des Wasserversorgungsgebiet-Eintrags.
authorityId
SchemaNullable
TypID
Neue zuständige Behörde, falls sich die Zuständigkeit ändert.
fields
SchemaNon-null
TypWsAreaUpdateFieldsInput!
Zu ändernde Felder. Nicht gesetzte Felder bleiben unverändert.
input.fields
active
SchemaNullable
TypBoolean
Gibt an, ob der Registereintrag aktiv ist.
name
SchemaNullable
TypString
Name des Wasserversorgungsgebiets.
additionalAuthorityIds
SchemaNullable
Typ[String!]
Weitere zuständige Behörden.
geoPosAndExtentFile
SchemaNullable
TypUpload
RegelKonditional
Fachlich konditional zur Geokoordinate: Wenn die räumliche Lage über ein Shapefile aktualisiert wird, wird die Geometrie als Multipart-Upload übertragen. Ohne Shapefile müssen die relevanten Koordinatenfelder fachlich passend gesetzt werden.
Geometrie- beziehungsweise Shapefile-Datei.
geoLatitude
SchemaNullable
TypDecimal
RegelKonditional
Fachlich konditional zur Geometrieangabe: Wird kein Shapefile übergeben, muss die Lage über Koordinaten beschrieben werden.
Geografische Breite.
geoLongitude
SchemaNullable
TypDecimal
RegelKonditional
Fachlich konditional zur Geometrieangabe: Wird kein Shapefile übergeben, muss die Lage über Koordinaten beschrieben werden.
Geografische Länge.
geoEasting
SchemaNullable
TypDecimal
RegelKonditional
Fachlich konditional zur Geometrieangabe: Wird kein Shapefile übergeben, muss die Lage über Koordinaten beschrieben werden.
Ostwert der geografischen Referenz.
geoNorthing
SchemaNullable
TypDecimal
RegelKonditional
Fachlich konditional zur Geometrieangabe: Wird kein Shapefile übergeben, muss die Lage über Koordinaten beschrieben werden.
Nordwert der geografischen Referenz.
lau2Code
SchemaNullable
Typ[String!]
LAU-2-Code der Gebietseinheit.
dailyWaterDelivery
SchemaNullable
TypDecimal
Tägliche Wasserabgabe.
numOfPeopleServed
SchemaNullable
TypInt
Anzahl der versorgten Personen.
refYearForDelivery
SchemaNullable
TypInt
Referenzjahr für Wasserabgabe und versorgte Personen.
examFreqAParam
SchemaNullable
TypInt
Untersuchungshäufigkeit für Parametergruppe A.
examFreqBParam
SchemaNullable
TypInt
Untersuchungshäufigkeit für Parametergruppe B.
dateOfEstablishment
SchemaNullable
TypDateTime
Datum der Einrichtung.
dateOfClosure
SchemaNullable
TypDateTime
Datum der Schließung.
reasonForClosure
SchemaNullable
TypString
XWasser-Code für den Schließungsgrund.
successorIds
SchemaNullable
Typ[String!]
Kennungen nachfolgender Wasserversorgungsgebiete.
comment
SchemaNullable
TypString
Freitextkommentar.
mutation WsAreaUpdate($input: WsAreaUpdateInput!) {
wsAreaUpdate(input: $input) {
  id
  name
  comment
  active
  editable
  authority { id name ty }
  responsible { id name ty }
}
}
{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "name": "API Testgebiet aktualisiert",
    "comment": "Aktualisierter Beispielkommentar"
  }
}
}
{
"data": {
  "wsAreaUpdate": {
    "id": "DEBY/0022054530211840/1780994403118",
    "name": "Wasserversorgungsgebiet Beispiel aktualisiert",
    "comment": "Aktualisierter Beispielkommentar",
    "active": true,
    "editable": true,
    "authority": {
      "id": "BY123GA801",
      "name": "Muster Gesundheitsamt",
      "ty": "HDP"
    },
    "responsible": {
      "id": "BY123GA801",
      "name": "Muster Gesundheitsamt",
      "ty": "HDP"
    }
  }
}
}

XWasser-Codes

Wenn eines dieser Felder geschrieben wird, muss ein gültiger Codewert aus der jeweiligen XWasser-Codeliste übergeben werden. Die allgemeine XWasser-Übersicht ist im XRepository unter XWasser auffindbar.

FeldCodelisteXRepositoryDatei
reasonForClosureGrund Schließung WasserversorgungsgebietCodeliste im XRepository öffnen.Grund Schließung Wasserversorgungsgebiet_1.xml

Grund der Schließung

Verwendete Version: Grund Schließung Wasserversorgungsgebiet_1.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeGrundBeschreibung
NN: Neufestlegung von WVG oder Zuordnung zu anderem(n) WVGSchließung wegen Neufestlegung von Wasserversorgungsgebieten oder Zuordnung zu anderem(n) Wasserversorgungsgebiet
OO: Andere GründeAndere Gründe für geänderte Trinkwasserbereitstellung
WW: Schlechte WasserqualitätSchlechte Wasserqualität, bei einem oder mehreren Parametern konnte der Grenzwert über längeren Zeitraum (z. B. 3 mal 3 Jahre) nicht eingehalten werden, geeignete Abhilfemaßnahmen waren nicht erfolgreich oder möglich

On this page

wsAreaUpdateXWasser-CodesGrund der Schließung