Inhalt der Dokumentation

Einrichtungsassistent

Stand und Eingaben der ersten Einstellungen.

3 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

get_stand
spaeter
speichern

`vm_erp.vm_erp.einrichtung.api.get_stand`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Alle Schritte mit Feldern und Standardwerten plus Stand und Fortschritt.

Rollen: Systemverwalter.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.einrichtung.api.get_stand"

{"message": ...}

`vm_erp.vm_erp.einrichtung.api.spaeter`

GET
POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Rollen: Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`schritt`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "schritt=<SCHRITT>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.einrichtung.api.spaeter"

{"message": ...}

`vm_erp.vm_erp.einrichtung.api.speichern`

GET
POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Ein Schritt einzeln. Bei Fehlern in der Eingabe wird nichts geschrieben und die Meldungen kommen zurueck.

Rollen: Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`schritt`	string	ja
`werte`	string	nein

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "schritt=<SCHRITT>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.einrichtung.api.speichern"

{"message": ...}