Resource Access

Diese Seite beschreibt den Zugriff auf Resourcen. Das hier Beschriebene gilt im Allgemeinen für alle verfügbaren Resourcen.

Um Zugriff auf Resourcen zur erhalten benötigt man einen Benutzeraccount. Hier gibt's Informationen zur Authentifizierung.

Liste von Resources abfragen

HTTP Befehl

GET /<resource name in plural>.xml

Beispiel

Aufruf der Liste aller Systeme

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

liefert eine Antwort wie diese

<systems>
 <system>
  ... 
 </system>
 <system>
  ... 
 </system>
</systems>

Eine einzelne Resource abfragen

Auf diese Art und Weise kann man die Daten einer einzelnen Resource abfragen. Im allgemeinen wird eine Resource über ihre UUID spezifiziert.

HTTP Befehle

GET /<resource name in plural>/<uuid der resource>.xml

Beispiel

Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A

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

Einer neuen Resource erstellen

HTTP Befehl

POST /systems.xml

Beispiel

Ein POST an

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

mit folgendem Inhalt

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

erstellt ein System mit dem Namen "Mein Auto". 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> 
 <name>Mein Auto</name> 
 <short-name></short-name> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <updated-at type="datetime">2009-06-19T10:34:06Z</updated-at> 
 <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid> 
 <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid> 
 ...
</system>

Eine vorhandene Resource aktualisieren

HTTP Befehl

PUT /<resource name in plural>/<uuid der resource>.xml

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:

<system> 
 <name>Mein tolles Auto</name> 
 <short-name></short-name> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <updated-at type="datetime">2009-06-19T12:01:18Z</updated-at> 
 <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid> 
 <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid> 
 ...
</system>

Siehe auch HTTP Post per Telnet.

Eine vorhandene Resource löschen

HTTP Befehl

DELETE /<resource name in plural>/<uuid der resource>.xml

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.

Abfrage Parameter

Beim Abfragen von Listen und einzelnen Resourcen können Parameter mit der URL übergeben werden. Auf den Seiten der Resourcen ist dokumentiert, welche Parameter unterstützt werden.