Beispiele zu Benutzern

Bei Benutzern handelt es sich um die im System vorhandenen User. Diese können über die API abgefragt, geändert und gelöscht werden.

Welche Felder im einzelnen bei Artikeln zur Verfügung stehen, kann am Besten in der API Testumgebung getestet werden. Diese verfügt über eine kontextgesteuerte Dokumentation und ist immer an den aktuellen Entwicklungsstand angepasst.

Eine Dokumentation dazu finden Sie auch im User Typen.

{warning} Die brshop24 API hat den Status "Work in progress". Bei dieser Dokumentation handelt sich um einen Vorabzug zu Testzwecken.

• Einleitung
• Query: Users
• Query: Users mit verknüpften Daten
• Query: Alle veröffentlichten Posts
• Mutation: Einen Benutzer erstellen
• Mutation: Einen Benutzer ändern
• Mutation: Einen Benutzer löschen

Query: Users

Eine einfache Abfrage der Benutzer kann wie folgt formuliert werden:

query users {
    users {
        data {
            id
            name
            email
        }
        total
    }
}

Query: Users mit verknüpften Daten

Eine Abfrage der Benutzer mit den zugehörigen Personen kann wie folgt formuliert werden:

query users {
    users {
        data {
            id
            name
            email
            reset_password_on_login
            people {
                id
                firstname
                lastname
            }
        }
        total
    }
}

Query: Users by Name

Eine Abfrage nach einem bestimmten Benutzernamen würde so aussehen:

query users {
    users(where:{name:"api"}) {
        data {
            id
            name
            email
            reset_password_on_login
            people {
                id
                firstname
                lastname
            }
        }
    }
}

Das Ergebnis dazu könnte wie folgt sein:

{
  "data": {
    "users": {
      "data": [
        {
          "id": 6,
          "name": "api",
          "email": "api@bueroring.de",
          "reset_password_on_login": false,
          "people": []
        }
      ]
    }
  }
}

Mutation: Einen Benutzer erstellen

Das Erstellen eines Benutzers könnte so aussehen:

mutation createUser {
    createUser(
        data: {
            name: "testuser"
            email: "bremer@bueroring.de"
            password: "test123"
            customer_id: 1
        }
    ) {
        id
    }
}

als Ergebnis wird hier, wie angefordert, die id des Benutzers zurück gegeben:

{
    "data": {
        "createUser": {
            "id": 24
        }
    }
}

Mutation: Einen Post ändern

Den oben erstellten Benutzer kann man wie folgt ändern:

mutation updateUser {
    updateUser(
        where: {id: 24}
        data: {
            name: "usertest"
            people: [
                {
                    id: 11,
                    related: true,
                }
            ]
        }
    ) {
        id
        name
        people {
            id
            firstname
            lastname
        }
    }
}

Damit wird eine der Name geändert und eine Person zugeordnet, Ergebnis:

{
    "data": {
        "updateUser": {
            "id": 24,
            "name": "usertest",
            "people": [
                {
                    "id": 11,
                    "firstname": "Petra",
                    "lastname": "Meier"
                }
            ]
        }
    }
}

Mutation: Einen Benutzer löschen

Den vorher angelegten Benutzer kann man mit folgendem Statement wieder löschen:

mutation deleteUser {
  deleteUser(where: {id: 24}) {
    id
    name
  }
}

Als Ergebnis wird hierbei die ID und der Name des gelöschten Benutzers ausgegeben:

{
    "data": {
        "deleteUser": {
            "id": 24,
            "name": "usertest"
        }
    }
}