Changes between Version 30 and Version 31 of DASISH/Scenario

Timestamp:

05/08/13 12:52:03 (11 years ago)

Author:

olhsha

Comment:

--

DASISH/Scenario

@@ -18 +18 @@
 = Authentication =
 * User logs-in to annotation service, "uid" gets known by the server. See [[SpecificationDocument#Userrealm | DASISH specification: user realm]] and [[XSD and XML#RespondingGETapiuseruid | Example: getting user information, incl. current-user flag]]
+
+
 
 = Visiting an annotated web page =
@@ -73 +75 @@
 
 = Editing an annotation body =
-'''TODO'''
+
+PUT
+
+Response: the envelope {A', R^*}, make a schema for it!!
+
+The same for posting
 
 = Managing readers and writers = 
 
-== Adding readers and writers ==
-'''TODO'''
+ReMOVE readers and writers from the annotations:
 
-== Removing readers and writers ==
-TODO
+Make list of the users with attribute permissions (add to schema!!)
+
+Give the list of the users for  a given annotation/notebook
+
+GET api/annotations/<aid>/permissions
+
+== Adding/Deleting readers and writers ==
+
+GET api/users/info?email=<...>
+
+Response: UID and the display name
+
+PUT api/annotations/<aid>/permissions
+
+body is the list
+
+Response in the envelope
+
+== Adding a reader/writer ==
+
+PUT api/annotations/<aid>/permissions/<uid>
+
+Body contains the access level of this user to this annotation
+
+No body in in response (no envelope), just an http status code
+
+== Removing a reader or a writer ==
+
+DELETE api/annotations/<aid>/permissions/<uid>
+
+No body in the response (no envelope), just an http status code
 
 = Managing annotations =
 
-== Deleting an entire annotation ==
-'''TODO'''
+== Deleting an entire annotation (if <uid> is an owner) ==
+
+DELETE api/annotations/<aid>
+
+No body in the response (no envelope), just an http status code
 
 = Notebooks =
 
-== Retrieving list of annotations in a notebook ==
-'''TODO'''
+== Retrieve notebooks Info ==
+
+GET api/notebooks
+
+== Retrieving the list of annotations in a notebook if <uid> has a read access to this notebook ==
+
+GET api/notebooks/<nid>/annotations/
+
+Response: XML list of annotation Info.
 
 == Adding an annotation to a notebook ==
-'''TODO'''
+
+PUT api/notebooks/<nid>/<aid>
+
+Response: status code
+