Recent changes to DeleteOwner

WikiPage DeleteOwner modified by Jim

Jim — Sat, 22 Sep 2012 09:52:21 -0000

--- v14
+++ v15
@@ -1,7 +1,8 @@
 ### Delete owner ###
 
 deletes an owner, can only be executed with the admin apikey
-all data of the owner become inaccesible
+
+##### ! all devices and data of the owner can not be accessed anymore
 
 Path: cs-ws/resources/admin/owners/{id}        Method: DELETE

WikiPage DeleteOwner modified by Jim

Jim — Sat, 22 Sep 2012 08:45:43 -0000

--- v13
+++ v14
@@ -18,15 +18,6 @@
 
 ~~~~~~
 DELETE http://localhost/cs-ws/resources/admin/owners/test6?apikey=1234 HTTP/1.1
-Accept-Encoding: gzip,deflate
-Content-Type: application/xml
-User-Agent: Jakarta Commons-HttpClient/3.1
-Host: localhost
-Content-Length: 84
 
 HTTP/1.1 200 OK
-Server: GlassFish Server Open Source Edition 3.1.2
-Content-Type: application/xml
-Content-Length: 174
-Date: Fri, 21 Sep 2012 19:51:20 GMT
 ~~~~~~

WikiPage DeleteOwner modified by Jim

Jim — Sat, 22 Sep 2012 08:00:02 -0000

--- v12
+++ v13
@@ -1,201 +1,3 @@
-# Owners #
-
--------
-
-### Create new Owner ###
-
-Creates a new owner and returns the newly created owner, can only be executed with the admin apikey
-
-Path: cs-ws/resources/admin/owners        Method: POST
-
-Parameters
-
-* apikey
-
-POST Data
-
-~~~~~~
-
-   ...        apikey for the created owner 
-   ...                optional id, if empty name is taken as id
-   ...            name of the owner
-
-~~~~~~
-
-Errors:
-
-* 409 CONFLICT if owner already exists
-* 401 UNAUTHORIZED if key is invalid or not admin key
-
-Example
-
-~~~~~~
-POST http://localhost/cs-ws/resources/admin/owners?apikey=1234 HTTP/1.1
-Accept-Encoding: gzip,deflate
-Content-Type: application/xml
-User-Agent: Jakarta Commons-HttpClient/3.1
-Host: localhost
-Content-Length: 82
-
-   9999
-   test5
-
-
-HTTP/1.1 201 Created
-Server: GlassFish Server Open Source Edition 3.1.2
-Content-Type: application/xml
-Content-Length: 171
-Date: Thu, 20 Sep 2012 19:54:32 GMT
-
-   
-      9999
-      test5
-      test5
-   
-   true
-
-~~~~~~
-
---------
-
-### List existing owners ###
-
-Returns a list of existing owners, can only be executed with the admin apikey
-
-Path: cs-ws/resources/admin/owners        Method: GET
-
-Parameters
-
-* apikey
-
-Errors:
-
-* 401 UNAUTHORIZED if key is invalid or not admin key
-
-Example
-
-~~~~~~
-GET http://localhost/cs-ws/resources/admin/owners?apikey=1234 HTTP/1.1
-Accept-Encoding: gzip,deflate
-Accept: application/xml
-User-Agent: Jakarta Commons-HttpClient/3.1
-Host: localhost
-
-HTTP/1.1 200 OK
-Server: GlassFish Server Open Source Edition 3.1.2
-Content-Type: application/xml
-Content-Length: 632
-Date: Fri, 21 Sep 2012 19:30:09 GMT
-
-   
-      5678
-      test3
-      test3
-   
-   
-      99999
-      test6
-      test6
-   
-   true
-
-~~~~~~
-
---------
-
-
-### Read a certain Owner ###
-
-Returns data of an existing owner identified by the apikey
-
-Path: cs-ws/resources/admin/owners/getOwner        Method: GET
-
-Parameters
-
-* apikey
-
-Errors:
-
-* 401 UNAUTHORIZED if key is invalid
-
-Example
-
-~~~~~~
-GET http://localhost/cs-ws/resources/admin/owners/getOwner?apikey=99999 HTTP/1.1
-Accept-Encoding: gzip,deflate
-Accept: application/xml
-User-Agent: Jakarta Commons-HttpClient/3.1
-Host: localhost
-
-HTTP/1.1 200 OK
-Server: GlassFish Server Open Source Edition 3.1.2
-Content-Type: application/xml
-Content-Length: 172
-Date: Fri, 21 Sep 2012 19:42:17 GMT
-
-   
-      99999
-      test6
-      test6
-   
-   true
-
-~~~~~~
-
---------
-
-### Modify owner ###
-
-changes the apikey of an owner, id and name my not be changed, can only be executed with the admin apikey
-
-Path: cs-ws/resources/admin/owners/{id}        Method: PUT
-
-Parameters
-
-* id
-* apikey
-
-PUT Data
-
-~~~~~~
-
-   ...        new apikey for the owner 
-   ...                has to be the same as the existing id
-   ...            has to be the same as the existing name
-
-~~~~~~
-
-Errors:
-
-* 401 UNAUTHORIZED if key is invalid or not admin key
-
-Example
-
-~~~~~~
-PUT http://localhost/cs-ws/resources/admin/owners/test6?apikey=1234 HTTP/1.1
-Accept-Encoding: gzip,deflate
-Content-Type: application/xml
-User-Agent: Jakarta Commons-HttpClient/3.1
-Host: localhost
-Content-Length: 84
-
-HTTP/1.1 200 OK
-Server: GlassFish Server Open Source Edition 3.1.2
-Content-Type: application/xml
-Content-Length: 174
-Date: Fri, 21 Sep 2012 19:51:20 GMT
-
-   
-      9999988
-      test6
-      test6
-   
-   true
-
-~~~~~~
-
---------
-
 ### Delete owner ###
 
 deletes an owner, can only be executed with the admin apikey

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 20:19:33 -0000

--- v11
+++ v12
@@ -196,32 +196,35 @@
 
 --------
 
-### Delete a certain Owner ###
-
-The owner to be deleted must be specified in the DELETE request body.
-
-###### Request ######
-
-~~~~~~
-cat <
-    
-	user1234
-	user
-	user
-    
-    EOT
-~~~~~~
-
-###### Result ######
-
-~~~~~~
-HTTP/1.1 200 OK
-X-Powered-By: Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1 Java/Sun Microsystems Inc./1.6)
-Server: GlassFish Server Open Source Edition 3.1
-Content-Type: application/json
-Transfer-Encoding: chunked
-Date: Wed, 09 Nov 2011 20:34:40 GMT
-
-{"success":"true"}
-~~~~~~
+### Delete owner ###
+
+deletes an owner, can only be executed with the admin apikey
+all data of the owner become inaccesible
+
+Path: cs-ws/resources/admin/owners/{id}        Method: DELETE
+
+Parameters
+
+* id
+* apikey
+
+Errors:
+
+* 401 UNAUTHORIZED if key is invalid or not admin key
+
+Example
+
+~~~~~~
+DELETE http://localhost/cs-ws/resources/admin/owners/test6?apikey=1234 HTTP/1.1
+Accept-Encoding: gzip,deflate
+Content-Type: application/xml
+User-Agent: Jakarta Commons-HttpClient/3.1
+Host: localhost
+Content-Length: 84
+
+HTTP/1.1 200 OK
+Server: GlassFish Server Open Source Edition 3.1.2
+Content-Type: application/xml
+Content-Length: 174
+Date: Fri, 21 Sep 2012 19:51:20 GMT
+~~~~~~

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 20:02:19 -0000

--- v10
+++ v11
@@ -144,36 +144,55 @@
 
 --------
 
-### Update a certain Owner ###
-
-To update a certain owner the data must be specified in the PUT request body.
-
-###### Request ######
-
-~~~~~~
-cat <
+### Modify owner ###
+
+changes the apikey of an owner, id and name my not be changed, can only be executed with the admin apikey
+
+Path: cs-ws/resources/admin/owners/{id}        Method: PUT
+
+Parameters
+
+* id
+* apikey
+
+PUT Data
+
+~~~~~~
 
-	newapikeyupdated
-	newuser
-	newuser
+   ...        new apikey for the owner 
+   ...                has to be the same as the existing id
+   ...            has to be the same as the existing name
 
-EOT
-~~~~~~
-
-###### Result ######
-
-~~~~~~
-HTTP/1.1 200 OK
-X-Powered-By: Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1 Java/Sun Microsystems Inc./1.6)
-Server: GlassFish Server Open Source Edition 3.1
-Content-Type: application/json
-Transfer-Encoding: chunked
-Date: Fri, 11 Nov 2011 20:18:23 GMT
-
-{"data":{"apikey":"newapikeyupdated","id":"newuser","name":"newuser"},"success":"true"}
-~~~~~~
-
+~~~~~~
+
+Errors:
+
+* 401 UNAUTHORIZED if key is invalid or not admin key
+
+Example
+
+~~~~~~
+PUT http://localhost/cs-ws/resources/admin/owners/test6?apikey=1234 HTTP/1.1
+Accept-Encoding: gzip,deflate
+Content-Type: application/xml
+User-Agent: Jakarta Commons-HttpClient/3.1
+Host: localhost
+Content-Length: 84
+
+HTTP/1.1 200 OK
+Server: GlassFish Server Open Source Edition 3.1.2
+Content-Type: application/xml
+Content-Length: 174
+Date: Fri, 21 Sep 2012 19:51:20 GMT
+
+   
+      9999988
+      test6
+      test6
+   
+   true
+
+~~~~~~
 
 --------

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 19:44:19 -0000

--- v9
+++ v10
@@ -106,25 +106,40 @@
 
 ### Read a certain Owner ###
 
-###### Request ######
-
-~~~~~~
-
-curl -X GET -i -H "Content-Type: application/xml; charset=utf-8" -H "Accept: application/json" "http://localhost:8080/cs-ws/resources/admin/owners/getOwner?apikey=1234"
-
-~~~~~~
-
-###### Result ######
-
-~~~~~~
-HTTP/1.1 200 OK
-X-Powered-By: Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1 Java/Sun Microsystems Inc./1.6)
-Server: GlassFish Server Open Source Edition 3.1
-Content-Type: application/json
-Transfer-Encoding: chunked
-Date: Wed, 09 Nov 2011 20:27:03 GMT
-
-{"data":{"apikey":"1234","id":"admin","name":"admin"},"deviceNameList":["MyDevice","MyDevice2"],"success":"true"}
+Returns data of an existing owner identified by the apikey
+
+Path: cs-ws/resources/admin/owners/getOwner        Method: GET
+
+Parameters
+
+* apikey
+
+Errors:
+
+* 401 UNAUTHORIZED if key is invalid
+
+Example
+
+~~~~~~
+GET http://localhost/cs-ws/resources/admin/owners/getOwner?apikey=99999 HTTP/1.1
+Accept-Encoding: gzip,deflate
+Accept: application/xml
+User-Agent: Jakarta Commons-HttpClient/3.1
+Host: localhost
+
+HTTP/1.1 200 OK
+Server: GlassFish Server Open Source Edition 3.1.2
+Content-Type: application/xml
+Content-Length: 172
+Date: Fri, 21 Sep 2012 19:42:17 GMT
+
+   
+      99999
+      test6
+      test6
+   
+   true
+
 ~~~~~~
 
 --------

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 19:38:28 -0000

--- v8
+++ v9
@@ -2,9 +2,9 @@
 
 -------
 
-#### Create new Owner ####
+### Create new Owner ###
 
-Creates a new owner, can only be executed with the admin apikey
+Creates a new owner and returns the newly created owner, can only be executed with the admin apikey
 
 Path: cs-ws/resources/admin/owners        Method: POST
 
@@ -21,8 +21,6 @@
    ...            name of the owner
 
 ~~~~~~
-
-Returns the newly created owner
 
 Errors:
 
@@ -60,33 +58,48 @@
 
 --------
 
+### List existing owners ###
 
-### List existing Owners ###
+Returns a list of existing owners, can only be executed with the admin apikey
 
-It lists all existing owners in the system.
+Path: cs-ws/resources/admin/owners        Method: GET
 
-###### Request ######
+Parameters
+
+* apikey
+
+Errors:
+
+* 401 UNAUTHORIZED if key is invalid or not admin key
+
+Example
 
 ~~~~~~
+GET http://localhost/cs-ws/resources/admin/owners?apikey=1234 HTTP/1.1
+Accept-Encoding: gzip,deflate
+Accept: application/xml
+User-Agent: Jakarta Commons-HttpClient/3.1
+Host: localhost
 
-curl -X GET -i -H "Content-Type: application/xml; charset=utf-8" -H "Accept: application/json" "http://localhost:8080/cs-ws/resources/admin/owners?apikey=1234"
-
+HTTP/1.1 200 OK
+Server: GlassFish Server Open Source Edition 3.1.2
+Content-Type: application/xml
+Content-Length: 632
+Date: Fri, 21 Sep 2012 19:30:09 GMT
+
+   
+      5678
+      test3
+      test3
+   
+   
+      99999
+      test6
+      test6
+   
+   true
+
 ~~~~~~
-
-###### Result ######
-
-~~~~~~
-HTTP/1.1 200 OK
-X-Powered-By: Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1 Java/Sun Microsystems Inc./1.6)
-Server: GlassFish Server Open Source Edition 3.1
-Content-Type: application/json
-Transfer-Encoding: chunked
-Date: Wed, 09 Nov 2011 20:09:22 GMT
-
-{"data":[{"apikey":"1234","id":"admin","name":"admin"},{"apikey":"papa23345345","id":"lala","name":"lala"},{"apikey":"user1234","id":"user","name":"user"}],"success":"true"}
-~~~~~~
-
-
 
 --------

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 19:26:53 -0000

--- v7
+++ v8
@@ -1,10 +1,10 @@
 # Owners #
-
-**For all CRUD operations the used apikey at the URL must belong to the admin owner.**
 
 -------
 
 #### Create new Owner ####
+
+Creates a new owner, can only be executed with the admin apikey
 
 Path: cs-ws/resources/admin/owners        Method: POST
 
@@ -16,9 +16,9 @@
 
 ~~~~~~
 
-   9999        apikey for the created owner 
-   test5               optional id, if empty name is taken as id
-   test5           name of the owner
+   ...        apikey for the created owner 
+   ...                optional id, if empty name is taken as id
+   ...            name of the owner
 
 ~~~~~~

WikiPage Owners modified by Jim

Jim — Fri, 21 Sep 2012 19:22:06 -0000

--- v6
+++ v7
@@ -6,13 +6,28 @@
 
 #### Create new Owner ####
 
-Path: cs-ws/resources/admin/owners
-
-Method: POST
+Path: cs-ws/resources/admin/owners        Method: POST
 
 Parameters
 
 * apikey
+
+POST Data
+
+~~~~~~
+
+   9999        apikey for the created owner 
+   test5               optional id, if empty name is taken as id
+   test5           name of the owner
+
+~~~~~~
+
+Returns the newly created owner
+
+Errors:
+
+* 409 CONFLICT if owner already exists
+* 401 UNAUTHORIZED if key is invalid or not admin key
 
 Example
 
@@ -25,7 +40,6 @@
 Content-Length: 82
 
    9999
-   test5
    test5

WikiPage Owners modified by Jim

Jim — Thu, 20 Sep 2012 21:08:00 -0000