Systems: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Rti (Diskussion | Beiträge) |
Rti (Diskussion | Beiträge) |
||
Zeile 182: | Zeile 182: | ||
|} | |} | ||
+ | == Abfrageparameter == | ||
+ | Das Abfragen von Systemen unterstützt den Parameter ''only''. Als Wert kann eine kommaseparierte Liste von Feldern angegeben werden. Die Antwort des Servers wird dann nur die angegebenen Felder enthalten. | ||
+ | |||
+ | === Beispiele === | ||
+ | Bei Listen: | ||
+ | /systems.xml?only=uuid,name | ||
+ | |||
+ | Liefert eine Antwort wie diese: | ||
+ | <systems type="array"> | ||
+ | <system> | ||
+ | <name type="string">Audi-A6</name> | ||
+ | <uuid type="string">A3DBE8F0-3EEA-012C-CE93-000D609CCCD8</uuid> | ||
+ | </system> | ||
+ | <system> | ||
+ | <name type="string">System in Debug Mode</name> | ||
+ | <uuid type="string">3EE03C70-49DE-012C-0B90-000D609CCCD8</uuid> | ||
+ | </system> | ||
+ | ... | ||
+ | </systems> | ||
+ | |||
+ | Beim Abfragen einzelner Objekte: | ||
+ | /systems/A3DBE8F0-3EEA-012C-CE93-000D609CCCD8.xml?only=last_map_text | ||
+ | |||
+ | Liefert folgende Antwort: | ||
+ | <system> | ||
+ | <last-map-text type="string"> | ||
+ | Staat: DE | ||
+ | Land: Berlin | ||
+ | Landkreis: Berlin | ||
+ | Postleitzahl: 13053 | ||
+ | Stadt: Berlin | ||
+ | Stadtbezirk: Alt-Hohenschönhausen | ||
+ | Strasse: Lukasstr. | ||
+ | Hausnummer: 5 | ||
+ | </last-map-text> | ||
+ | </system> | ||
[[Category:WebserviceResources]] | [[Category:WebserviceResources]] |
Version vom 12. Februar 2010, 13:16 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. ecoTRACK welches unter anderem die Positionen eines Fahrzeuges meldet.
Details zum Zugriff auf Resourcen, wie z.B. auch Systeme sind unter Resourcenzugriff zu finden.
Inhaltsverzeichnis
Verknüpfungen
- ist einem Customer zugeordnet
- kann weiteren Customers zugeordnet sein - momentan in Entwicklung
- hat viele Refuelings
- hat viele Positions
- hat viele Events
Struktur eine Systems
<system> <serial type="string">01A87B1B0C0000CA</serial> <name type="string">Audi-A6</name> <remarks type="string">keine Bemerkung :)</remarks> <gps-correction nil="true"/> <created-at type="datetime">2009-06-19T10:34:06Z</created-at> <use-dst nil="true"/> <provider-id type="integer">3</provider-id> <connected nil="true"/> <uuid type="string">A3DBE8F0-3EEA-012C-CE93-000D609CCCD8</uuid> <updated-at type="datetime">2009-11-05T10:33:25Z</updated-at> <fueltype-id type="integer">2</fueltype-id> <devicetype-id type="integer">1</devicetype-id> <last-timestamp type="datetime">2010-02-12T03:50:33Z</last-timestamp> <last-world-x type="float">13.522977</last-world-x> <license-plate type="string">B - PS 3329</license-plate> <gmt-offset nil="true"/> <last-world-y type="float">52.553032</last-world-y> <last-status type="integer">208</last-status> <last-map-text type="string">Staat: DE Land: Berlin Landkreis: Berlin Postleitzahl: 13053 Stadt: Berlin Stadtbezirk: Alt-Hohenschönhausen Strasse: Lukasstr. Hausnummer: 5 </last-map-text> <short-name type="string">Tom</short-name> <customer-uuid type="string">67F49140-AC24-012C-4FFD-000D609CCCD8</customer-uuid> <sms-number type="string">+4915783031117</sms-number> <is-alias nil="true"/> <status type="string">SN:01A87B1B0C0000CA|SV:2.18|ST:ALL|SM:NORMAL|GS:E-Plus(28)V07.03.200|GP:9(1.1)|RT:4.208|SS:0|BL:0|DN:17</status> <password type="string">ok2</password> </system>
Bedeutung der Felder
Name | Typ | Bedeutung | Beispiel |
connected | Boolean | ob das System gerade verbunden ist und Daten sendet | false |
created-at | UTC Timestamp | Zeitpunkt der Erstellung des Datensatzes | 2010-01-21T22:12:01Z |
devicetype-id (deprecated) | Integer | ID des Gerätetyps (Hersteller, Modell) | 3 |
fueltype-id (deprecated) | Integer | ID des Kraftstofftyps | 2 |
gmt-offset (deprecated) | Integer | Zeitverschiebung zu GMT | -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 | secret771#?2 |
provider-id (deprecated) | Integer | ID des GSM Providers | 3 |
remarks | String | Bemerkungsfeld | linker Scheinwerfer defekt |
serial | String | Seriennummer des Systems | 01A87B1B0C0000CA |
short-name | String | Kurzbezeichnung des Systems | 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 |
updated-at | UTC Timestamp | Zeitpunkt der letzten Aktualisierung des Datensatzes | 2010-01-22T15:04:01Z |
use-dst (deprecated) | Boolean | Sommerzeitumstellung vornehmen | true |
uuid | String | Eindeutige ID des Systems | A3DBE8F0-3EEA-012C-CE93-000D609CCCD8 |
customer-uuid | String | Eindeutige ID des Kunden | 67F49140-AC24-012C-4FFD-000D609CCCD8 |
last-world-x | float | Longitude Wert der letzten Systemposition | 13.523162 |
last-world-y | float | Latitude Wert der letzten Systemposition | 52.553108 |
last-map-text | String | Adresstext der letzten Position | Staat: DE Land: Berlin Landkreis: Berlin Postleitzahl: 13053 Stadt: Berlin Stadtbezirk: Alt-Hohenschönhausen Strasse: Lukasstr. Hausnummer: 9 |
last-status | Integer | Letzter Status des Systems | 20 |
last-timestamp | UTC Timestamp | Zeitpunkt des letzten Meldung des Systems | 2010-02-28T01:44:21Z |
is-alias | Boolean | true, wenn dieses System aus einem anderen Customer hier hinein verlinkt wurde | false |
Abfrageparameter
Das Abfragen von Systemen unterstützt den Parameter only. Als Wert kann eine kommaseparierte Liste von Feldern angegeben werden. Die Antwort des Servers wird dann nur die angegebenen Felder enthalten.
Beispiele
Bei Listen:
/systems.xml?only=uuid,name
Liefert eine Antwort wie diese:
<systems type="array"> <system> <name type="string">Audi-A6</name> <uuid type="string">A3DBE8F0-3EEA-012C-CE93-000D609CCCD8</uuid> </system> <system> <name type="string">System in Debug Mode</name> <uuid type="string">3EE03C70-49DE-012C-0B90-000D609CCCD8</uuid> </system> ... </systems>
Beim Abfragen einzelner Objekte:
/systems/A3DBE8F0-3EEA-012C-CE93-000D609CCCD8.xml?only=last_map_text
Liefert folgende Antwort:
<system> <last-map-text type="string"> Staat: DE Land: Berlin Landkreis: Berlin Postleitzahl: 13053 Stadt: Berlin Stadtbezirk: Alt-Hohenschönhausen Strasse: Lukasstr. Hausnummer: 5 </last-map-text> </system>