Changeset 5512

Timestamp:

08/01/14 13:14:43 (10 years ago)

Author:

Twan Goosen

Message:

Updated Protocol.txt, now reflecting the behaviour of the operation for getting a single VC
Refs #604

File:

• VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/Protocol.txt (modified) (3 diffs)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/Protocol.txt

@@ -18 +18 @@
         - "Accept" can be used all requests. Accepted values are "text/xml",
           "application/xml" or "application/json". If the header is not set,
-          the VCR assumes "application/xml" as default.
+          the VCR assumes "application/xml" as default. An exception is the retrieval
+          of individual collections (2d). This call also accepts "application/x-cmdi+xml"
+          and "text/html" and defaults to the former of these two.
         - Headers for HTTP Basic Auth need to be set on POST, PUT and DELETE
           requests.      
+          
+        Note that, as an alternative to the usage of the HTTP "Accept" header, the respons 
+        type can be controlled by providing one of the following suffixes to the service
+        URL: ".xml", ".json", ".cmdi", ".html". Not all operations will accept all of
+        these types.
 
 
@@ -96 +103 @@
               authentication: not required
                 request body: none
-                 result body: Depending on Accept header either an XML instance
-                              or the JSON representation of the virtual
-                              collection. If the virtual collection is not found
-                              the appropriate HTTP status code is issued and an
+                 result body: Depending on Accept header either a CMDI, XML or
+                              JSON representation of the virtual collection, or a redirect
+                              to the collection's detail view in the user interface in 
+                              case HTML is requested. If the virtual collection is not 
+                              found the appropriate HTTP status code is issued and an 
                               error message is returned.
+                              By default, it returns the CMDI representation for published
+                              collections. If the collection is not published, the
+                              service will respond with another accepted representation.
+                              If only CMDI is represented, it responds with code 406
+                              (Not Acceptable).
 
     e) Retrieve all / search virtual collections (GET)
@@ -146 +159 @@
                               an empty list will be returned.
 
-    g) Retrieve a virtual collection in CMDI format (GET)
-                 description: The virtual collection referenced by the URI will
-                              be retrieved in CMDI format.
-                 HTTP method: GET
-                         URI: $BASE/service/virtualcollections/$id/cmdi
-         URI path parameters: $id := is the ID of the virtual collection,
-                                     which is to be retrieved
-            query parameters: none
-                HTTP headers: none
-              authentication: not required
-                request body: none
-                 result body: The virtual collection in CMDI format If the
-                              virtual collection is not found the appropriate
-                              HTTP status code is issued and an error message
-                              is returned.
-
 TODO: Add {id}/state