Systems: Unterschied zwischen den Versionen

Aus ARTECO Wiki
Zur Navigation springen Zur Suche springen
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.
 
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 aller Systeme ==
  
 
Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf.
 
Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf.
Zeile 20: Zeile 20:
  
 
=== Beispiele ===
 
=== Beispiele ===
 
+
Aufruf der Liste aller Systeme
'''Aufruf der Liste aller Systeme'''
 
 
  GET http://xml.arteco.de/systems.xml
 
  GET http://xml.arteco.de/systems.xml
  
'''Aufruf der Liste aller Systeme, jedoch nur die Felder "uuid" und "short_name"'''
+
Aufruf der Liste aller Systeme, jedoch nur die Felder "uuid" und "short_name"
 
  GET http://xml.arteco.de/systems.xml?only=uuid,short_name
 
  GET http://xml.arteco.de/systems.xml?only=uuid,short_name
  
 
== Ein System ==
 
== Ein System ==
 
 
Diese Resource bietet Zugriff auf die Daten eines Systems.
 
Diese Resource bietet Zugriff auf die Daten eines Systems.
  
Zeile 35: Zeile 33:
 
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 Befehls ===
+
=== HTTP Befehle ===
 
  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
Zeile 49: Zeile 47:
  
 
=== Beispiele ===
 
=== Beispiele ===
 
+
Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A
'''Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A'''
 
 
 
 
  http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
 
  http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
  
'''Aufruf des Systems mit dem "short_name" "mein auto"'''
+
Aufruf des Systems mit dem "short_name" "mein auto"
 
 
 
  http://xml.arteco.de/systems/mein%20auto.xml
 
  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"'''
+
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
 
  http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml?only=uuid,short_name
  
 
== Erstellen eines neuen Systems ==
 
== Erstellen eines neuen Systems ==

Version vom 5. Januar 2010, 20:42 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.

Liste aller 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 Befehle

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

Erstellen eines neuen Systems