SHAPTH
Use Case
wsAreaCreate

Wasserversorgungsgebiete erstellen

Dieser Use Case beschreibt das Erstellen eines neuen Wasserversorgungsgebiet-Eintrags über GraphQL.

Berechtigungws_area:manage
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE

wsAreaCreate

Die Mutation verwendet ein ressourcenspezifisches Create-Input. Felder mit XWasser-Code müssen mit gültigen Codewerten aus den fachlichen Codelisten befüllt werden.

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
TypWsAreaCreateInput!
Eingabeobjekt für wsAreaCreate.
input
authorityId
SchemaNon-null
TypID!
ID der zuständigen Behörde.
handOver
SchemaNullable
TypBoolean
Steuert, ob die Pflegeverantwortung direkt übergeben werden soll.
fields
SchemaNon-null
TypWsAreaCreateFieldsInput!
Fachliche Felder.
input.fields
name
SchemaNon-null
TypString!
Name.
ident
SchemaNon-null
TypString!
Fachlicher Identifikator des Wasserversorgungsgebiets, fachlich mit Länderkennung, zum Beispiel DEBY/1234.
additionalAuthorityIds
SchemaNullable
Typ[ID!]
Weitere zuständige Behörden.
geoPosAndExtentFile
SchemaNullable
TypUpload
RegelKonditional
Fachlich konditional zur Geokoordinate: Wenn die räumliche Lage über ein Shapefile übergeben 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.
geoNorthing
SchemaNullable
TypDecimal
RegelKonditional
Fachlich konditional zur Geometrieangabe: Wird kein Shapefile übergeben, muss die Lage über Koordinaten beschrieben werden.
Nordwert.
lau2Code
SchemaNullable
Typ[String!]
LAU-2-Code.
dailyWaterDelivery
SchemaNullable
TypDecimal
Tägliche Wasserabgabe.
numOfPeopleServed
SchemaNullable
TypInt
Anzahl der versorgten Personen.
refYearForDelivery
SchemaNullable
TypInt
Referenzjahr.
examFreqAParam
SchemaNullable
TypInt
Untersuchungshäufigkeit Parametergruppe A.
examFreqBParam
SchemaNullable
TypInt
Untersuchungshäufigkeit Parametergruppe B.
dateOfEstablishment
SchemaNon-null
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!]
Nachfolgende Wasserversorgungsgebiete.
comment
SchemaNullable
TypString
Freitextkommentar.
mutation WsAreaCreate($input: WsAreaCreateInput!) {
wsAreaCreate(input: $input) {
  r
  id
  name
  geoLatitude
  geoLongitude
  geoEasting
  geoNorthing
  lau2Code
  dailyWaterDelivery
  numOfPeopleServed
  refYearForDelivery
  examFreqAParam
  examFreqBParam
  dateOfEstablishment
  dateOfClosure
  successorIds
  comment
  geoPosAndExtent {
    filehash
    filename
    mimeType
    size
    url
  }
  active
  editable
  reasonForClosure { code text desc }
  authority { id name ty }
  responsible { id name ty }
}
}
{
"input": {
  "authorityId": "<DUMMY-SHAPTH-ID>",
  "handOver": false,
  "fields": {
    "name": "API Testgebiet",
    "ident": "<DUMMY-SHAPTH-ID>",
    "additionalAuthorityIds": ["<DUMMY-SHAPTH-ID>"],
    "geoLatitude": 48.137154,
    "geoLongitude": 11.576124,
    "geoEasting": 1234,
    "geoNorthing": 1234,
    "dateOfEstablishment": "2020-02-05T23:00:00+00:00",
    "dateOfClosure": "2026-06-09T22:00:00+00:00",
    "reasonForClosure": "N",
    "lau2Code": ["12 0 52 000 0000"],
    "dailyWaterDelivery": 27.4,
    "numOfPeopleServed": 100,
    "refYearForDelivery": 2025,
    "examFreqAParam": 4,
    "examFreqBParam": 1,
    "successorIds": ["<DUMMY-SHAPTH-ID>"],
    "comment": "Beispielkommentar"
  }
}
}
{
"data": {
  "wsAreaCreate": {
    "r": "2B34CE6BE000",
    "id": "DEBY/0022054530211840/1780994403118",
    "name": "API Testgebiet",
    "geoLatitude": "48.137154",
    "geoLongitude": "11.576124",
    "geoEasting": "1234",
    "geoNorthing": "1234",
    "lau2Code": ["12 0 52 000 0000"],
    "dailyWaterDelivery": "27.4",
    "numOfPeopleServed": 100,
    "refYearForDelivery": 2025,
    "examFreqAParam": 4,
    "examFreqBParam": 1,
    "dateOfEstablishment": "2020-02-05T23:00:00+00:00",
    "dateOfClosure": "2026-06-09T22:00:00+00:00",
    "successorIds": ["DETH/010101"],
    "comment": "Beispielkommentar",
    "geoPosAndExtent": null,
    "active": true,
    "editable": true,
    "reasonForClosure": {
      "code": "N",
      "text": "N: Neufestlegung von WVG oder Zuordnung zu anderem(n) WVG",
      "desc": "Schließung wegen Neufestlegung von Wasserversorgungsgebieten oder Zuordnung zu anderem(n) Wasserversorgungsgebiet"
    },
    "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

wsAreaCreateXWasser-CodesGrund der Schließung