SHAPTH
Use Case
waterSupplierCreate

Betreiber Niederlassung erstellen

Dieser Use Case beschreibt das Erstellen einer Betreiber-Niederlassung über GraphQL.

Berechtigung
admin oder applicant
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE
i
Funktionshinweis

Funktion eingeschränkt, in Klärung.

waterSupplierCreate

Niederlassungen werden mit waterSupplierCreate erstellt. Der Unterschied zum Haupteintrag ist der gesetzte parent-Wert.

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
TypWaterSupplierCreateInput!
Eingabeobjekt für waterSupplierCreate.
input
federalState
SchemaNon-null
TypString!
Bundesland beziehungsweise zuständige Landeskennung.
parent
SchemaNullable
TypID
ID des Hauptstandorts. Nur für Nebenstandorte zu setzen.
fields
SchemaNon-null
TypWaterSupplierCreateFieldsInput!
Stammdaten des Betreibers.
input.fields
info
SchemaNon-null
TypWaterSupplierInfoInput!
Betreiberinformation. Im Beispiel wird die company-Variante verwendet.
input.fields.info
company
SchemaNullable
TypWaterSupplierCompanyInfoInput
Unternehmensbezogene Betreiberinformation.
input.fields.info.company
name
SchemaNon-null
TypString!
Name des Unternehmens.
input.fields
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
TypCreateSlimContact!
Kontaktinformationen.
input.fields.contact
mailbox
SchemaNullable
TypString
Funktionspostfach.
email
SchemaNon-null
Typ[String!]!
E-Mail-Adressen.
phone
SchemaNon-null
Typ[String!]!
Telefonnummern.
comment
SchemaNullable
TypString
Kontaktkommentar.
mutation WaterSupplierCreate($input: WaterSupplierCreateInput!) {
waterSupplierCreate(input: $input) {
  id
  name
  info {
    __typename
    ... on WaterSupplierAuthorityInfo { name }
    ... on WaterSupplierCompanyInfo { name }
    ... on WaterSupplierPersonInfo { salutation title firstname lastname }
  }
  address {
    street
    house
    zip
    place
    additional
    state
  }
  contact {
    mailbox
    email
    phone
    comment
  }
  active
  editable
  parent { id name }
  branches
}
}
{
"input": {
  "federalState": "BY",
  "parent": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "info": {
      "company": {
        "name": "API Betreiber Niederlassung GmbH"
      }
    },
    "address": {
      "street": "Versorgerweg",
      "house": "2",
      "zip": "80331",
      "place": "München",
      "additional": "Niederlassung Süd",
      "state": "BY"
    },
    "contact": {
      "mailbox": "Postfach 789",
      "email": ["kontakt@example-wsp.org"],
      "phone": ["+49 89 112233"],
      "comment": "Kontakt für Niederlassung"
    }
  }
}
}
{
"data": {
  "waterSupplierCreate": {
    "id": "DEBY/WSP/0002",
    "name": "API Betreiber Niederlassung GmbH",
    "info": {
      "__typename": "WaterSupplierCompanyInfo",
      "name": "API Betreiber Niederlassung GmbH"
    },
    "address": {
      "street": "Versorgerweg",
      "house": "2",
      "zip": "80331",
      "place": "München",
      "additional": "Niederlassung Süd",
      "state": "BY"
    },
    "contact": {
      "mailbox": "Postfach 789",
      "email": ["kontakt@example-wsp.org"],
      "phone": ["+49 89 112233"],
      "comment": "Kontakt für Niederlassung"
    },
    "active": true,
    "editable": true,
    "parent": {
      "id": "BT3022054360342528",
      "name": "API Betreiber GmbH"
    },
    "branches": 0
  }
}
}

On this page

waterSupplierCreate