Systems: Unterschied zwischen den Versionen
Rti (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „== Liste der Systeme == Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf. Im Normalfall sind das alle Systeme de…“) |
Rti (Diskussion | Beiträge) |
||
| Zeile 1: | Zeile 1: | ||
| + | Die Resource '''System''' stellt Fahrzeuge und ähnliches dar. Technisch gesehen ist ein System ein Gerät wie z.B. das A.R.T.E.C.O. EFB welches unter anderem die Positionen einen Fahrzeuges meldet. | ||
| + | |||
== Liste der Systeme == | == Liste der Systeme == | ||
| − | Diese Resource liefert die Liste aller Systeme, | + | Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf. |
| − | die der aktuell angemeldete Benutzer sehen darf. | ||
| − | Im Normalfall sind das alle Systeme des Kunden, dem | + | Im Normalfall sind das alle Systeme des Kunden, dem der Benutzer angehört und alle Systeme der Unterkunden dieses Kunden. |
| − | der Unterkunden dieses Kunden. | ||
=== HTTP Befehl === | === HTTP Befehl === | ||
| − | GET /systems.xml | + | GET /systems.xml |
=== Mögliche Parameter in der URL === | === Mögliche Parameter in der URL === | ||
| − | only | + | {| border="1" |
| + | | '''Parameter''' | ||
| + | | '''Bedeutung''' | ||
| + | |- | ||
| + | | only | ||
| + | | Komma getrennte Liste der gewünschten Felder | ||
| + | |} | ||
=== Beispiele === | === Beispiele === | ||
| Zeile 21: | Zeile 27: | ||
GET http://xml.arteco.de/systems.xml?only=uuid,short_name | GET http://xml.arteco.de/systems.xml?only=uuid,short_name | ||
| − | == | + | == Ein System == |
Diese Resource bietet Zugriff auf die Daten eines Systems. | Diese Resource bietet Zugriff auf die Daten eines Systems. | ||
| Zeile 29: | Zeile 35: | ||
Spezifiziert man das System über den 'short_name', so kann man nur Systeme des eigenen Kunden abrufen. | Spezifiziert man das System über den 'short_name', so kann man nur Systeme des eigenen Kunden abrufen. | ||
| − | === HTTP | + | === HTTP Befehls === |
GET /systems/UUID-DES-SYSTEMS.xml | GET /systems/UUID-DES-SYSTEMS.xml | ||
GET /systems/SHORT-NAME-DES-SYSTEMS.xml | GET /systems/SHORT-NAME-DES-SYSTEMS.xml | ||
=== Mögliche Parameter in der URL === | === Mögliche Parameter in der URL === | ||
| − | only | + | {| border="1" |
| + | | '''Parameter''' | ||
| + | | '''Bedeutung''' | ||
| + | |- | ||
| + | | only | ||
| + | | Komma getrennte Liste der gewünschten Felder | ||
| + | |} | ||
=== Beispiele === | === Beispiele === | ||
Version vom 5. Januar 2010, 20:40 Uhr
Die Resource System stellt Fahrzeuge und ähnliches dar. Technisch gesehen ist ein System ein Gerät wie z.B. das A.R.T.E.C.O. EFB welches unter anderem die Positionen einen Fahrzeuges meldet.
Inhaltsverzeichnis
Liste der Systeme
Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf.
Im Normalfall sind das alle Systeme des Kunden, dem der Benutzer angehört und alle Systeme der Unterkunden dieses Kunden.
HTTP Befehl
GET /systems.xml
Mögliche Parameter in der URL
| Parameter | Bedeutung |
| only | Komma getrennte Liste der gewünschten Felder |
Beispiele
Aufruf der Liste aller Systeme
GET http://xml.arteco.de/systems.xml
Aufruf der Liste aller Systeme, jedoch nur die Felder "uuid" und "short_name"
GET http://xml.arteco.de/systems.xml?only=uuid,short_name
Ein System
Diese Resource bietet Zugriff auf die Daten eines Systems.
Das System wird entweder über die UUID oder über den 'short_name' spezifiziert. Mit Hilfe der UUID können Systeme des eigenen Kunden und Systeme aller Unterkunden abgerufen werden. Spezifiziert man das System über den 'short_name', so kann man nur Systeme des eigenen Kunden abrufen.
HTTP Befehls
GET /systems/UUID-DES-SYSTEMS.xml GET /systems/SHORT-NAME-DES-SYSTEMS.xml
Mögliche Parameter in der URL
| Parameter | Bedeutung |
| only | Komma getrennte Liste der gewünschten Felder |
Beispiele
Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A
http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
Aufruf des Systems mit dem "short_name" "mein auto"
http://xml.arteco.de/systems/mein%20auto.xml
Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A, jedoch nur die Felder "uuid" und "short_name"
http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml?only=uuid,short_name
