[Opensim-dev] RFC: RESTful dealings with regions

[Dr Scofield]

we are currently trying to figure out what the best approach for a REST 
"API" for regions is and would like to solicit comments :-)

currently the idea is to have a scheme as follows:

    * http://opensim.foobar.org:9000/admin/regions ---
          o GET returns an array of (UUID, name, x location, y location,
            region's REST URL)
          o POST would create a region
    * http://opensim.foobar.org:9000/admin/regions/4b787c46-1e3c-40ae-9494-2c924428f8e5/
          o GET would return detailed information about region
          o DELETE would delete region
          o PUT would update region information
    * http://opensim.foobar.org:9000/admin/regions/4b787c46-1e3c-40ae-9494-2c924428f8e5/name
          o GET would return name of region
          o PUT would update name of region
          o [similar for other region attributes if it makes sense]

current planning is to have this as an ApplicationPlugin level set of 
RestPlugins. an alternative would be to use region modules plus an 
ApplicationPlugin (for GET/POST on /admin/regions).

this applies to region (meta) data. the next question would be how to 
structure this for avatar information and also for stuff like inventory: 
something along the lines below?

    * http://opensim.foobar.org/admin/avatars
          o GET returns list of known avatars?
          o POST creates account?
    * http://opensim.foobar.org/admin/avatars/430f1da7-0e35-4c0f-985d-15046c077967/
          o GET returns detailed information about avatar?
          o PUT updates?
          o DELETE deletes?
    * http://opensim.foobar.org/admin/avatars/430f1da7-0e35-4c0f-985d-15046c077967/inventory/
          o GET returns inventory listing?
          o POST adds items to inventory?
          o DELETE deletes inventory items?


would love to hear from you guys.

    cheers,
    dirk

-- 
dr dirk husemann, mathmatics and computer science, ibm zurich research lab
SL: dr scofield ---- drscofield at xyzzyxyzzy.net ---- http://xyzzyxyzzy.net/
RL: hud at zurich.ibm.com - +41 44 724 8573 - http://www.zurich.ibm.com/~hud/