kz.arta.synergy.api.rest.diary

Class DiaryService

java.lang.Object

kz.arta.synergy.api.rest.diary.DiaryService

public class DiaryService
extends java.lang.Object

Created by IntelliJ IDEA. User: topa Date: 19.06.13 Time: 8:45 To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
DiaryService()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createTask(java.lang.String task, java.lang.String taskID, java.lang.String start, java.lang.String finish, boolean wholeDay, java.lang.String userID, java.lang.String locale) Метод для создания/изменения задачи URL rest/api/diary/tasks/{userID}/save Method POST
java.lang.String	deleteTask(java.lang.String taskID, java.lang.String locale) Метод для удаление задачи URL rest/api/diary/tasks/delete Method GET
java.lang.String	getModifiedTasks(java.lang.String userID, java.lang.String locale, java.lang.String lastModified) Метод возвращает заметки измененные за последнее время URL rest/api/diary/tasks/{userID} Method GET Пример: http://хост:порт/Synergy/rest/api/diary/tasks/uuid_пользователя?
Response	getTask(java.lang.String taskID, java.lang.String locale) Получение заметки по идентификатору URL /rest/api/diary/tasks/get Method GET Метод принимает следующие входные параметры: - `taskID` - `uuid` заметки (обяз.); - `locale` - локаль.
java.lang.String	getUserID()
Response	getUserTasks(java.lang.String userID, java.lang.String start, java.lang.String finish, java.lang.String locale) Получения заметок пользователя из календаря за промежуток времени URL rest/api/diary/tasks/{userID}/all Method GET
Response	setTaskState(java.lang.String taskID, java.lang.String locale) Метод для завершения заментки URL rest/api/diary/tasks/complete Method GET

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiaryService

public DiaryService()

Method Detail

getModifiedTasks

public java.lang.String getModifiedTasks(java.lang.String userID,
                                         java.lang.String locale,
                                         java.lang.String lastModified)

Метод возвращает заметки измененные за последнее время

URL rest/api/diary/tasks/{userID}
Method GET

Пример:
http://хост:порт/Synergy/rest/api/diary/tasks/uuid_пользователя?last-modified=2013-01-01%2008:00:00
Для описания оорфмата json смотрите документацию метода taskToJson(Task)

Parameters:

userID - uuid пользователя, чьи задачи необходимо посмотреть

locale - локаль

lastModified - стамп времени

Returns:

список заметок, измененных с момента lastModified в формате json

See Also:

#taskToJson(arta.synergy.web.common.client.data.tasks.Task)

createTask

public java.lang.String createTask(java.lang.String task,
                                   java.lang.String taskID,
                                   java.lang.String start,
                                   java.lang.String finish,
                                   boolean wholeDay,
                                   java.lang.String userID,
                                   java.lang.String locale)

Метод для создания/изменения задачи

URL rest/api/diary/tasks/{userID}/save
Method POST

Parameters:

task - текст задачи

taskID - идентификатор задачи (в случае добавления новой задачи должен отсутствовать)

start - дата начала в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)

finish - дата завершения в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)

wholeDay - в течение целого дня или нет

userID - идентификатор пользователя для которого создается задача

locale - локаль

Returns:

json вида {errorCode: code_value, errorMessage: some_message} Если errorCode = 0, значит действие было выполнено успешно, иначе- нет и в errorMessage должна содержаться информация об ошибке

deleteTask

public java.lang.String deleteTask(java.lang.String taskID,
                                   java.lang.String locale)

Метод для удаление задачи

URL rest/api/diary/tasks/delete
Method GET

Parameters:

taskID - идентификатор задачи

locale - локаль

setTaskState

public Response setTaskState(java.lang.String taskID,
                             java.lang.String locale)

Метод для завершения заментки

URL rest/api/diary/tasks/complete
Method GET

Parameters:

taskID - идентификатор задачи (в случае добавления новой задачи должен отсутствовать)

locale - локаль

Пример запроса:

`/rest/api/diary/tasks/complete?taskID=e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee`

Пример возвращаемого объекта:

{ "errorCode": 0, "errorMessage": "Заметка успешно завершена" }

getTask

public Response getTask(java.lang.String taskID,
                        java.lang.String locale)

Получение заметки по идентификатору

URL /rest/api/diary/tasks/get
Method GET Метод принимает следующие входные параметры:

- `taskID` - `uuid` заметки (обяз.);

- `locale` - локаль.

Метод возвращает описание заметки с указанным идентификатором.

В случае успешного выполнения метод возвращает объект `JSON`, состоящий из следующих полей:

- `taskID` - `uuid` заметки;

- `task` - текст заметки;

- `start` - дата и время начала исполнения заметки, в формате `yyyy-MM-dd HH:mm:ss`;

- `finish` - дата и время завершения исполнения заметки, в формате `yyyy-MM-dd HH:mm:ss`;

- `wholeDay` - признак исполнения заметки в течение дня. Одно из следующих значений:

- `true` - установлен срок исполнения "в течение дня";

- `false` - не установлен срок исполнения "в течение дня".

Пример запроса:

`rest/api/diary/tasks/get?taskID=e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee`

Пример возвращаемого массива:

{ "taskID" : "e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №1", "start" : "2016-12-05 10:00:00", "finish" : "2016-12-05 16:00:00", "wholeDay" : false }

getUserTasks

public Response getUserTasks(java.lang.String userID,
                             java.lang.String start,
                             java.lang.String finish,
                             java.lang.String locale)

Получения заметок пользователя из календаря за промежуток времени

URL rest/api/diary/tasks/{userID}/all
Method GET

Parameters:

start - дата начала в формате yyyy-MM-dd

finish - дата завершения в формате yyyy-MM-dd

userID - идентификатор пользователя чьи заметки необходимо получить

locale - локаль

Пример запроса:

`rest/api/diary/tasks/8f60bf3b-0fff-11e9-bfb4-001ef892a4ee/all?start=2016-12-05&finish=2016-12-25`

Пример возвращаемого массива:

[ { "taskID" : "e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №1", "start" : "2016-12-05 10:00:00", "finish" : "2016-12-05 16:00:00" }, { "taskID" : "5dfc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №2", "start" : "2016-12-10 09:45:00", "finish" : "2016-12-10 12:00:00" }, { "taskID" : "21sdd1sb0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №3", "start" : "2016-12-20 09:00:00", "finish" : "2016-12-20 18:00:00" }, { "taskID" : "11lc40b0-5fkh-11e6-9ce4-001ef892a4ee", "task" : "заметка №4", "start" : "2016-12-25 09:00:00", "finish" : "2016-12-25 18:00:00" } ]

getUserID

public java.lang.String getUserID()