Systems

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 eines Fahrzeuges meldet. Jedes System ist einem Customer zugeordnet.

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

http://xml.arteco.de/systems.xml

Aufruf der Liste aller Systeme, jedoch nur die Felder "uuid" und "short_name"

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

So kann man ein neues System erstellen.

HTTP Befehl

POST /systems.xml

Mögliche Parameter in der URL

keine

Beispiel

Ein POST an

http://xml.arteco.de/systems.xml

mit folgendem Inhalt

<system> 
 <name>Mein Auto</name> 
 <provider-id>3</provider-id> 
</system>

erstellt ein System mit dem Namen "Mein Auto" mit der Provider ID 3. Siehe auch HTTP Post per Telnet.

Als Antwort liefert der Server das soeben erstelle System inclusive auf dem Server generierter Daten (wie z.B. der UUID) zurück.

<system> 
 <connected type="boolean">false</connected> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <devicetype-id type="integer">0</devicetype-id> 
 <fueltype-id type="integer">0</fueltype-id> 
 <gmt-offset type="integer" nil="true"></gmt-offset> 
 <gps-correction nil="true"></gps-correction> 
 <license-plate></license-plate> 
 <name>Mein Auto</name> 
 <password></password> 
 <provider-id type="integer">3</provider-id> 
 <remarks></remarks> 
 <serial></serial> 
 <short-name></short-name> 
 <sms-number></sms-number> 
 <status></status> 
 <updated-at type="datetime">2009-06-19T10:34:06Z</updated-at> 
 <use-dst type="boolean">false</use-dst> 
 <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid> 
 <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid> 
 <last-world-x type="float"></last-world-x> 
 <last-world-y type="float"></last-world-y> 
 <last-map-text></last-map-text> 
 <last-status type="integer"></last-status> 
 <last-timestamp type="datetime"></last-timestamp> 
</system>

Ein System aktualisieren

So kann man ein vorhandenes System aktualisieren.

HTTP Befehl

PUT /systems/UUID-DES-SYSTEMS.xml

Mögliche Parameter in der URL

keine

Beispiel

Ein PUT an

http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml

mit folgendem Inhalt

<system> 
 <name>Mein tolles Auto</name> 
</system>

ändert den Namen des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A auf "Mein tolles Auto". Der Server liefert, wie auch beim Erstellen eines Systems, das XML Dokument zurück. Siehe auch HTTP Post per Telnet.

Ein System löschen

So kann man ein vorhandenes System löschen.

HTTP Befehl

DELETE /systems/UUID-DES-SYSTEMS.xml

Mögliche Parameter in der URL

keine

Beispiel

Ein DELETE an

http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml

löscht das System mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A.