Virtual Marketer ERP
Inhalt der Dokumentation

Startseite

Kennzahlen der Startseite.

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

vm_erp.vm_erp.startseite.api.rueckstaende

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

ParameterTypPflichtBeschreibung
filtersstringnein

Felder der Antwort (message): fieldtype, route, value

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.startseite.api.rueckstaende"
{"message": ...}

vm_erp.vm_erp.startseite.api.startseite_daten

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Vorschlagsleiste und Erste-Schritte-Karte fuer die Startseite. Ohne Recht auf die Vorschlaege bleibt die Leiste leer. Die Karte verschwindet bei 100 Prozent.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

Felder der Antwort (message): erste_schritte, vorschlaege

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.startseite.api.startseite_daten"
{"message": ...}

vm_erp.vm_erp.startseite.api.versandbereit

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

ParameterTypPflichtBeschreibung
filtersstringnein

Felder der Antwort (message): fieldtype, route, route_options, value

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.startseite.api.versandbereit"
{"message": ...}