From 11e816cee2a165591f72bbb4f4fcc5f9b3b7b366 Mon Sep 17 00:00:00 2001
From: Manuel Rego Casasnovas <rego@igalia.com>
Date: Wed, 28 Nov 2012 18:05:47 +0100
Subject: [PATCH] doc: Add documentation about the new bound users web services

FEA: ItEr77S14BoundUsersWebServices
---
 scripts/rest-clients/README | 40 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/scripts/rest-clients/README b/scripts/rest-clients/README
index 9193fc57e..9f88ea386 100644
--- a/scripts/rest-clients/README
+++ b/scripts/rest-clients/README
@@ -5,7 +5,7 @@ Web Services
 
 :Author: Manuel Rego Casasnovas
 :Contact: rego@igalia.com
-:Date: 27/08/2012
+:Date: 28/11/2012
 :Copyright:
   Some rights reserved. This document is distributed under the Creative
   Commons Attribution-ShareAlike 3.0 licence, available in
@@ -311,3 +311,41 @@ Other
       * URL: ``/ws/rest/resourceshours/<resource-code>/<start-date>/<end-date>/``
 
   * DTO: ``org.libreplan.ws.resources.api.ResourceWorkedHoursListDTO``
+
+Bound users
+~~~~~~~~~~~
+
+Special services intended to be used by bound resources. The user and password
+for the service correspond to the bound user.
+
+There are 3 services:
+
+* My tasks:
+
+  * Export assigned tasks to the bound user:
+
+    * HTTP method: ``GET``
+    * No parameters
+    * URL: ``/ws/rest/bounduser/mytasks/``
+
+  * DTO: ``org.libreplan.ws.boundusers.api.TaskListDTO``
+
+* Timesheets by task:
+
+  * Export the personal timesheets data of the bound user for a task:
+
+    * HTTP method: ``GET``
+    * Parameters: ``<task-code>``
+    * URL: ``/ws/rest/bounduser/timesheets/<task-code>``
+
+  * DTO: ``org.libreplan.ws.boundusers.api.PersonalTimesheetEntryListDTO``
+
+* Import personal timesheets:
+
+  * Import personal timesheets of the bound user:
+
+    * HTTP method: ``POST``
+    * No parameters
+    * URL: ``/ws/rest/bounduser/timesheets/``
+
+  * DTO: ``org.libreplan.ws.boundusers.api.PersonalTimesheetEntryListDTO``