Systems: Unterschied zwischen den Versionen

Aus ARTECO Wiki
Zur Navigation springen Zur Suche springen
 
(34 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt)
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 eines 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. ecoTRACK welches unter anderem die Positionen eines Fahrzeuges meldet.
  
−
== Liste aller Systeme ==
+
Details zum Zugriff auf Resourcen, wie z.B. auch Systeme sind unter [[Resource_Access|Resourcenzugriff]] zu finden.
  
−
Diese Resource liefert die Liste aller Systeme, die der aktuell angemeldete Benutzer sehen darf.
+
__TOC__
 +
== Verknüpfungen ==
 +
* ist einem [[Customers|Customer]] zugeordnet
 +
* ''kann weiteren [[Customers]] zugeordnet sein - '''momentan in Entwicklung''' ''
 +
* hat viele [[Refuelings]]
 +
* hat viele [[Positions]]
 +
* hat viele [[Events]]
  
−
Im Normalfall sind das alle Systeme des Kunden, dem der Benutzer angehört und alle Systeme der Unterkunden dieses Kunden.
+
== Struktur eines Systems ==
−
 
+
<system>
−
 
+
  <serial type="string">01A87B1B0C0000CA</serial>
−
=== HTTP Befehl ===
+
  <name type="string">Audi-A6</name>
−
  GET /systems.xml
+
  <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>
  
  
−
=== Mögliche Parameter in der URL ===
+
=== Bedeutung der Felder ===
−
{| border="1"
+
{| border="1" cellpadding="3" style="border-collapse:collapse;"
−
| '''Parameter'''
+
| '''Name'''
 +
| '''Typ'''
 
| '''Bedeutung'''
 
| '''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
 
|-  
 
|-  
−
| only
+
| name
−
| Komma getrennte Liste der gewünschten Felder
+
| String
−
|}
+
| Name des Systems
−
 
+
| Mein Auto
−
 
+
|-
−
=== Beispiele ===
+
| password
−
Aufruf der Liste aller Systeme
+
| String
−
http://xml.arteco.de/systems.xml
+
| Ursprünglich zur Authentifizierung
−
 
+
| secret771#?2
−
Aufruf der Liste aller Systeme, jedoch nur die Felder "uuid" und "short_name"
+
|-
−
http://xml.arteco.de/systems.xml?only=uuid,short_name
+
| ''provider-id'' (deprecated)
−
 
+
| Integer
−
 
+
| ID des GSM Providers
−
== Ein System ==
+
| 3
−
Diese Resource bietet Zugriff auf die Daten eines Systems.
+
|-  
−
 
+
| remarks
−
Das System wird entweder über die UUID oder über den 'short_name' spezifiziert.
+
| String
−
Mit Hilfe der UUID können Systeme des eigenen Kunden und Systeme aller Unterkunden abgerufen werden.
+
| Bemerkungsfeld
−
Spezifiziert man das System über den 'short_name', so kann man nur Systeme des eigenen Kunden abrufen.
+
| linker Scheinwerfer defekt
−
 
 
−
 
 
−
=== HTTP Befehle ===
 
−
GET /systems/UUID-DES-SYSTEMS.xml
 
−
GET /systems/SHORT-NAME-DES-SYSTEMS.xml
 
−
 
 
−
 
 
−
=== Mögliche Parameter in der URL ===
 
−
{| border="1"
 
−
| '''Parameter'''
 
−
| '''Bedeutung'''
 
 
|-  
 
|-  
−
| only
+
| serial
−
| Komma getrennte Liste der gewünschten Felder
+
| 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
 +
| 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
 +
|-
 +
| 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&#246;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 ==
 +
=== Liste ===
 +
/systems.xml?
 +
  only=name,uuid&
 +
  updated_since=2010-01-12T14:33:01&
 +
  customer_uuid=3EBC47EC-4D38-4130-99F8-15724E297F09
  
−
=== Beispiele ===
+
* [[Only]]
−
Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A
+
* [[Updated_Since]]
−
http://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
+
* [[Customer_UUID]]
−
 
 
−
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
 
  
 +
=== Einzelobjekte ===
 +
/systems/A3DBE8F0-3EEA-012C-CE93-000D609CCCD8.xml?
 +
  only=last_map_text,uuid,name
  
−
=== Beispiel ===
+
* [[Only]]
−
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.
+
[[Category:WebserviceResources]]

Aktuelle Version vom 11. September 2013, 13:43 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.

Verknüpfungen

Struktur eines 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

Liste

/systems.xml?
  only=name,uuid&
  updated_since=2010-01-12T14:33:01&
  customer_uuid=3EBC47EC-4D38-4130-99F8-15724E297F09

Einzelobjekte

/systems/A3DBE8F0-3EEA-012C-CE93-000D609CCCD8.xml?
  only=last_map_text,uuid,name
Abgerufen von „https://wiki.arteco.de/index.php?title=Systems&oldid=2581“