Systems: Unterschied zwischen den Versionen

Version vom 6. Januar 2010, 12:51 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 eines Fahrzeuges meldet. Jedes System ist einem Customer zugeordnet.

Struktur eine Systems

<system> 
 <connected type="boolean">false</connected> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <devicetype-id type="integer">1</devicetype-id> 
 <fueltype-id type="integer">2</fueltype-id> 
 <gmt-offset type="integer" nil="true"></gmt-offset> 
 <gps-correction nil="true"></gps-correction> 
 <license-plate>B - PS 3329</license-plate> 
 <name>Audi-A6</name> 
 <password></password> 
 <provider-id type="integer">3</provider-id> 
 <remarks>keine Bemerkung :)</remarks> 
 <serial>01A87B1B0C0000CA</serial> 
 <short-name>Tom</short-name> 
 <sms-number>+4915783031117</sms-number> 
 <status>SN:01A87B1B0C0000CA|SV:2.15|ST:ALL|SM:NORMAL|GS:E-Plus(26)V07.03.200|GP:8(1.1)|RT:6.313|SS:0|BL:0|DN:8</status> 
 <updated-at type="datetime">2009-11-05T10:33:25Z</updated-at> 
 <use-dst type="boolean">false</use-dst> 
 <uuid>A3DBE8F0-3EEA-012C-CE93-000D609CCCD8</uuid> 
 <customer-uuid>67F49140-AC24-012C-4FFD-000D609CCCD8</customer-uuid> 
 <last-world-x type="float">13.523162</last-world-x> 
 <last-world-y type="float">52.553108</last-world-y> 
 <last-map-text>Staat: DE
Land: Berlin
Landkreis: Berlin 
Postleitzahl: 13053
Stadt: Berlin
Stadtbezirk: Alt-Hohenschönhausen
Strasse: Lukasstr. 
Hausnummer: 9 
</last-map-text> 
 <last-status type="integer">208</last-status> 
 <last-timestamp type="datetime">2010-01-03T19:23:16Z</last-timestamp> 
</system>

Bedeutung der Felder

Name

Typ

Bedeutung

Bemerkung

Beispiel

connected

Boolean

ob das System gerade verbunden ist und Daten sendet

false

created-at

UTC Timestamp

Zeitpunkt der Erstellung des Datensatzes

false

devicetype-id

Integer

ID des Gerätetyps (Hersteller, Modell)

3

fueltype-id

Integer

ID des Kraftstofftyps

für Kraftstoffverbrauchsberechnungen

2

gmt-offset

Integer

Zeitverschiebung zu GMT

momentan nicht in Benutzung

-3

gps-correction

String

Art des GPS Korrektur Signals

AGRV

license-plate

String

Nummernschild

B-AB 1234

name

String

Name des Systems

Mein Auto

password

String

Ursprünglich zur Authentifizierung

Momentan nicht nötig

secret771#?2

provider-id

Integer

ID des GSM Providers

3

remarks

String

Bemerkungsfeld

für beliebige Notizen

linker Scheinwerfer defekt

serial

String

Seriennummer des Systems

01A87B1B0C0000CA

-

short-name

String

Kurzbezeichnung des Systems, auch zum Zugriff nutzbar

auto123

-

sms-number

String

GSM Nummer des Systems

+491771234567

-

status

String

Aktueller Status der Firmware

SV:2.15|ST:ALL|SM:NORMAL|GS:E-Plus(26)V07.03.200|GP:8(1.1)|RT:6.313|SS:0|BL:0|DN:8

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.

@@ Zeile 81: / Zeile 81: @@
 |
 | AGRV
+|-
+| license-plate
+| String
+| Nummernschild
+|
+| B-AB 1234
+|-
+| name
+| String
+| Name des Systems
+|
+| Mein Auto
+|-
+| password
+| String
+| Ursprünglich zur Authentifizierung
+| Momentan nicht nötig
+| secret771#?2
+|-
+| provider-id
+| Integer
+| ID des GSM Providers
+|
+| 3
+|-
+| remarks
+| String
+| Bemerkungsfeld
+| für beliebige Notizen
+| linker Scheinwerfer defekt
+|-
+| serial
+| String
+| Seriennummer des Systems
+|
+| 01A87B1B0C0000CA
+| -
+| short-name
+| String
+| Kurzbezeichnung des Systems, auch zum Zugriff nutzbar
+|
+| auto123
+| -
+| sms-number
+| String
+| GSM Nummer des Systems
+|
+| +491771234567
+| -
+| status
+| String
+| Aktueller Status der Firmware
+|
+| SN:01A87B1B0C0000CA|SV:2.15|ST:ALL|SM:NORMAL|GS:E-Plus(26)V07.03.200|GP:8(1.1)|RT:6.313|SS:0|BL:0|DN:8
 |}
 == Liste aller Systeme ==

Systems: Unterschied zwischen den Versionen

Version vom 6. Januar 2010, 12:51 Uhr

Inhaltsverzeichnis

Struktur eine Systems

Bedeutung der Felder

Liste aller Systeme

HTTP Befehl

Mögliche Parameter in der URL

Beispiele

Ein System

HTTP Befehle

Mögliche Parameter in der URL

Beispiele

Erstellen eines neuen Systems

HTTP Befehl

Mögliche Parameter in der URL

Beispiel

Ein System aktualisieren

HTTP Befehl

Mögliche Parameter in der URL

Beispiel

Ein System löschen

HTTP Befehl

Mögliche Parameter in der URL

Beispiel

Navigationsmenü

Meine Werkzeuge

Namensräume

Varianten

Ansichten

Mehr

Suche

Wiki

Werkzeuge