Changeset 284


Ignore:
Timestamp:
03/25/10 10:49:35 (14 years ago)
Author:
oschonef
Message:
  • add missing query parameters
  • fix bad cut & paste ;)
File:
1 edited

Legend:

Unmodified
Added
Removed
  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/Protocol.txt

    r280 r284  
    5656                 HTTP method: PUT
    5757                         URI: $BASE/service/virtualcollection/$id
    58          URI path parameters: $id := is the ID of the virtual collection,
    59                                      which is to be changed
     58         URI path parameters: $id := (required) is the ID of the virtual
     59                                     collection, which is to be changed
    6060            query parameters: none
    6161                HTTP headers: Content-Type (required), Accept (optional)
     
    7575                 HTTP method: DELETE
    7676                         URI: $BASE/service/virtualcollection/$id
    77          URI path parameters: $id := is the ID of the virtual collection,
    78                                      which is to be deleted
     77         URI path parameters: $id := (required) is the ID of the virtual
     78                                     collection, which is to be deleted 
    7979            query parameters: none
    8080                HTTP headers: Accept (optional)
     
    9090                 HTTP method: GET
    9191                         URI: $BASE/service/virtualcollection/$id
    92          URI path parameters: $id := is the ID of the virtual collection,
    93                                      which is to be retrieved
     92         URI path parameters: $id := (required) is the ID of the virtual
     93                                     collection, which is to be retrieved
    9494            query parameters: none
    9595                HTTP headers: Accept (optional)
     
    110110                         URI: $BASE/service/virtualcollections
    111111         URI path parameters: none
    112             query parameters: q := URL-encoded query expression (see below)
     112            query parameters: q      := (optional) URL-encoded query
     113                                        expression (see below)
     114                              offset := (optional) start of result list at
     115                                        a given position (default: 0)
     116                              count  := (optional) limit the result list to
     117                                        a number of entries (default: unlimited)
    113118                HTTP headers: Accept (optional)
    114119              authentication: not required
     
    116121                 result body: Depending on Accept header either an XML instance
    117122                              or the JSON representation of the virtual
    118                               collection. If the virtual collection is not found
    119                               the appropriate HTTP status code is issued and an
    120                               error message is returned.
     123                              collection. If no virtual collection are found
     124                              an empty list will be returned.
    121125
    122126    f) Retrieve all / search virtual collection owned by the user (GET)
     
    128132                         URI: $BASE/service/my-virtualcollections
    129133         URI path parameters: none
    130             query parameters: q := URL-encoded query expression (see below)
     134            query parameters: q      := (optional) URL-encoded query
     135                                        expression (see below)
     136                              offset := (optional) start of result list at
     137                                        a given position (default: 0)
     138                              count  := (optional) limit the result list to
     139                                        a number of entries (default: unlimited)
    131140                HTTP headers: Accept (optional)
    132141              authentication: required
     
    134143                 result body: Depending on Accept header either an XML instance
    135144                              or the JSON representation of the virtual
    136                               collection. If the virtual collection is not found
    137                               the appropriate HTTP status code is issued and an
    138                               error message is returned.
     145                              collection. If no virtual collection are found
     146                              an empty list will be returned.
    139147
    140148    g) Retrieve a virtual collection in CMDI format (GET)
Note: See TracChangeset for help on using the changeset viewer.