A tutorial demonstrating a few examples is available here: (Test takers) Rest and (Results) RestResults

List of available rest controllers

Authentification methods

  • HTTP/Basic

Digest and Oauth authentification methods support is planned

Supported HTTP methods

  • GET
  • POST
  • PUT
  • DELETE

Supported Accept encodings

  • Accept: application/json
  • Accept: application/xml

Supported default headers

Generic headers aliases:

  • uri
  • label
  • comment
  • type

Generic headers\ By default you may refer to any attribute of the target resource type using header with the uri reference :

“http://tao-dev/taodev.rdf\#i1372429454323825” : “35”

Specific header aliases\ Specific header aliases may be supported on extension basis, example :

  • “login”
  • “password”
  • “guiLg”
  • “dataLg”
  • “firstName”

  • “mail”

  • “member”
  • “model”

…

Header parameters requirements

Depending on the type of operation and the type of target resource types, some requirements may apply. In this case , a message is returned according to the requested encoding (JSON/XML) with a message information

Returned types and exception handling

Depending on the type of operation and the type of target resource types,

a message is always returned using the requested encoding with a status information and a message :

example in XML :

true

http://tao-dev/taodev.rdf#i13777687654193852

core_kernel_persistence_smoothsql_Class::createInstanceWithProperties

2.5-alpha

example in JSON:

{
success: false
errorCode: 0
errorMsg: "One of the precondition for this type of request was not satisfied"
version: "2.5-alpha"
}

HTTP error codes are used along the returned message

  • 400
  • 401
  • 412
  • 406
  • 404
  • 403
  • 200
  • 204

Building your own controller for your own extension

You may extend the tao_actions_CommonRestModule and override

  • getParametersAliases()

    example : return array_merge(parent::getParametersAliases(), array( “login”=> PROPERTY_USER_LOGIN, “password” => PROPERTY_USER_PASSWORD, “guiLg” => PROPERTY_USER_UILG, “dataLg” => PROPERTY_USER_DEFLG, “firstName”=> PROPERTY_USER_LASTNAME, “mail”=> PROPERTY_USER_MAIL, “type”=> RDF_TYPE ));

  • getParametersRequirements()

example :

return array(

/ *

  • you may use either the alias or the uri, if the parameter identifier\

  • is set it will become mandatory for the operation in $key\

  • Default Parameters Requirements are applied\

  • type by default is not required and the root class type is applied\

*/

“post”=> array(“login”, “password”)

);

This abstract controller will handle for you

  • the http request and trigger the correct service from your implementation of service set up in\ \$this->service = taoSubjects_models_classes_CrudSubjectsService::singleton();
  • Authentification
  • parameters check, ACL controls
  • Encoding of the returned Data
  • exception handling

Examples