Virtual Marketer ERP
Inhalt der Dokumentation

Rahmenaufträge

Rahmenaufträge mit Restmenge und Abrufprüfung.

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

vm_erp.vm_erp.rahmen.api.get_rahmen

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Rahmenauftraege mit Restmenge, Restlaufzeit und Warnung kurz vor Ablauf.

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

Parameter: keine.

Felder der Antwort (message): beispiel, zeilen

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

vm_erp.vm_erp.rahmen.api.pruefe_abruf

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Prueft nur, bucht nichts.

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

ParameterTypPflichtBeschreibung
namestringja
artikelstringja
mengestringja
curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "name=<NAME>" \
  --data-urlencode "artikel=<ARTIKEL>" \
  --data-urlencode "menge=<MENGE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.rahmen.api.pruefe_abruf"
{"message": ...}