REST-API-Dokumentation

You are here:
< Back

(Vorläufige Version)

Vorgefertigte PHP-Dateien gibt es hier: https://git.fphst.de/FPH/SpedV-REST-PHP

Endpunkt:

https://api.sped-v.de/rest/api?apikey=APIKey&function=Funktion

Funktionen:

  • getpositions: Ruft eine Liste mit Koordinaten aller aktuell fahrenden Nutzer ab.
  • getonlineusers: Ruft eine Liste der aktuell angemeldeten Nutzer ab.
  • getusers: Gibt alle Nutzer der Spedition zurück
  • getuserstats: Gibt die Nutzerstatistik zurück
  • getranks: Gibt (mit entsp. Rechten) die Ränge der Spedi aus
  • getbranches: Gibt (mit entsp. Rechten) die Niederlassungen der Spedi aus
  • gettrucks: Gibt (mit entsp. Rechten) die LKWs der Spedi aus
  • gettasks: Gibt alle Aufträge der Spedi aus
  • gettask (weiterer Parameter id): Gibt genauere Informationen zu einem Auftrag zurück
  • getsped: Gibt vollständige Speditionsinfos aus
  • getspedmoney: Gibt (mit entsp. Rechten) die Bankkonten der Spedi aus
  • getspedtarget: Gibt das Speditionsziel aus
  • getspedstats: Gibt Speditionsstatistiken aus
  • getvacations: Gibt (mit entsp. Rechten) Urlaube aus
  • gettrucktypes: Gibt alle vorhandenen LKW-Typen aus
  • getacttask: Gibt den aktuellen Auftrag des angemeldeten Nutzers aus
  • getownconvoyinfo: Gibt vollständige Fahrtdaten des angemeldeten Nutzers aus
  • whoami: Gibt zurück, zu wem der API-Key gehört
  • getsystemstats: Gibt Systemstatistiken aus.