kz.arta.synergy.api.rest.notifications

Class NotificationsService

java.lang.Object

kz.arta.synergy.api.rest.notifications.NotificationsService

public class NotificationsService
extends java.lang.Object

Created by IntelliJ IDEA. User: topa Date: 14.01.14 Time: 18:08 To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
NotificationsService()

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(long lastGetTime, boolean subscribedOnly, java.util.List<java.lang.Integer> actionType, java.util.List<java.lang.Integer> objectType, java.lang.String locale) Метод возвращает уведомления для авторизованного пользователя URL rest/api/notifications/get Method GET
java.lang.String	getHost()
java.lang.String	getUserID()
Response	send(NotificationSend sendInfo) Метод API для отправки произвольного уведомления пользователю URL: rest/api/notifications/send Method POST Метод принимает следующие входные параметры (json): header - заголовок/тема уведомления (не обяз.); message - тело уведомления (обяз.); users - массив uuid пользователей, которым необходимо отправить уведомление; groups - массив uuid групп пользователей, которым необходимо отправить уведомление; logins - массив логинов пользователей, которым необходимо отправить уведомление; emails - массив произвольных e-mail, которым необходимо отправить уведомление; locale - локаль.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationsService

public NotificationsService()

Method Detail

get

public java.lang.String get(long lastGetTime,
                            boolean subscribedOnly,
                            java.util.List<java.lang.Integer> actionType,
                            java.util.List<java.lang.Integer> objectType,
                            java.lang.String locale)

Метод возвращает уведомления для авторизованного пользователя

URL rest/api/notifications/get
Method GET

Parameters:

lastGetTime - Время последнего получения уведомлений в миллисекундах, если ранее уведомления не запрашивались значние передавать не надо - система сама определит количество последних уведомлений, которые надо вернуть

subscribedOnly - true - система вернет только те типы уведомлений на получение которых пользователь подписан, согласно настройкам в системе, false - вернет все типы уведомлений

actionType - идентификатор типа уведомления (action_types.typeID), передача этого ограничивает возвращаемые уведомления данным типом/типами. Если необходимо передать несколько типов уведомлений - параметр надо указать в запросе несколько раз

objectType - идентификатор объекта, передача этого параметра ограничиывает возвращаемые уведомления по типу объекта, к которому они относятся. Если необходимо передать несколько типов объектов - параметр надо указать в запросе несколько раз Обрабатываются значения парамтра:
4 - работа, проекты
8 - задача
2 - цель
16 - показатель

locale - локаль авторизованного пользователя

Returns:

список уведомлений, удовлетворяющих параметрам и текущее время в миллисекундах. Это время надо передать при получении следующей порции уведомлений.
Формат ответа:

 
{
 
 "lasGetTime": "yyyy-MM-dd HH:ss:mm",       - стамп времени получения уведомлений
 
 "notifications":                           - список уведомлений
 
 [
 
 {
 
  "time":"",                                - время события
 
  "notification":""                         - текст уведомления
 
 }, ...
 
 ]
 

 

send

public Response send(NotificationSend sendInfo)

Метод API для отправки произвольного уведомления пользователю URL: rest/api/notifications/send
Method POST
Метод принимает следующие входные параметры (json):

header - заголовок/тема уведомления (не обяз.);
message - тело уведомления (обяз.);
users - массив uuid пользователей, которым необходимо отправить уведомление;
groups - массив uuid групп пользователей, которым необходимо отправить уведомление;
logins - массив логинов пользователей, которым необходимо отправить уведомление;
emails - массив произвольных e-mail, которым необходимо отправить уведомление;
locale - локаль.
Пример передаваемого запроса: { "header": "Срочное собрание!", "message": "Прошу Вас собраться в 10:00 в актовом зале.", "users": ["7b953be8-bddb-4ce4-bbfd-ae9548f69c7f", "e65f62fa-7045-4b5b-b61d-46ca00ea7af1"], "groups": [1, 5, 7], "logins": ["Абдрешен", "Слепаков", "user_100500", "1"], "emails": ["bobrov@arta.kz"] }

Parameters:

sendInfo - json-объект;

Returns:

В случае успешного выполнения json со следующими полями:

• errorCode = 0
• errorMessage = Уведомление отправлено

в случае ошибки вернет json со следующими полями

• errorCode = код ошибки
• errorMessage = сообщение

Пример возвращаемого json-объекта при успешном выполнении метода:

    {
        "errorCode": 0,
        "errorMessage": "Уведомление отправлено"
    }
 

getHost

public java.lang.String getHost()

getUserID

public java.lang.String getUserID()