Revision: 1862
Author: [email protected]
Date: Wed Mar 3 07:14:54 2010
Log: REST API content of the old simal.oss-watch.ac.uk web site.
http://code.google.com/p/simal/source/detail?r=1862
Added:
/wiki/SimalRESTAPI.wiki
=======================================
--- /dev/null
+++ /wiki/SimalRESTAPI.wiki Wed Mar 3 07:14:54 2010
@@ -0,0 +1,67 @@
+#summary The Simal REST API
+#labels Phase-Design
+
+= Introduction =
+
+This page describes the Simal REST API.
+
+= Details =
+
+==URL Structure==
+
+All REST URLs are of the same form:
+
+{{{http://foo.com/simal-rest/COMMAND/NAME_VALUE_PAIRS/FORMAT}}}
+
+Where COMMAND is the command you wish to execute, NAME_VALUE_PAIRS is zero
or more parameter names and value pairs and FORMAT is a format code that
specifies the format of the response document.
+
+==Project Data==
+
+===Add a project===
+
+To add a project using a DOAP POST to:
+
+{{{http://foo.com/simal-rest/addProject
+The RDF project data should be contained in a parameter called rdf .
+
+===Retrieve a Single Project===
+
+To retrieve the details of a single project use:
+
+{{{http://foo.com/simal-rest/project/project-ID/FORMAT}}}
+
+===All Projects===
+
+To retrieve all projects from the standard SIMAL repository use:
+
+{{{http://foo.com/simal-rest/allProjects/FORMAT}}}
+
+==Person Data==
+
+==Retrieve a Single Person==
+
+To retrieve the details of a single person use:
+
+{{{http://foo.com/simal-rest/person/person-ID/FORMAT}}}
+
+===All Colleagues of a Person===
+
+A colleague is defined as someone who works on any of the projects our
target person works on.
+
+To retrieve all colleagues from the standard SIMAL repository use:
+
+{{{http://foo.com/simal-rest/allColleagues/person-ID/FORMAT}}}
+
+Where PERSON_ID is replaced with the Simal ID of the person we are
interested in.
+
+===Retrieve all People===
+
+To retrieve the details of all people use:
+
+{{{http://foo.com/simal-rest/allPeople/FORMAT}}}
+
+==Alternative Data Sources==
+
+Simal can retrieve data from sources other than the standard Simal
repository. Such as the MyExperiment social networking tool for scientific
research. In order to use alternative data sources use the "source"
parameter as follows:
+
+{{{http://foo.com/simal-rest/allColleagues/source-myExperiment/PERSON-ID/FORMAT}}}
--
You received this message because you are subscribed to the Google Groups "Simal
Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simal-commits?hl=en.
