iGov.ua APIs

Contents
1. Аутентификация пользователя
2. Activiti
6. Загрузки прикрепленного к заявке файла из постоянной базы
7. Работа с мерчантами
8. Бэкап/восстановление данных таблиц сервисов и мест
9. Работа с документами
10. Работа с субъектами
11. Предоставление и проверка доступа к документам
12. Работа с сообщениями
13. Работа с историей (Мой журнал)
14. Аплоад(upload) и прикрепление файла в виде атачмента к таске Activiti
15. Работа с каталогом сервисов
16. Получение статистики по задачам в рамках бизнес процесса
17. Работа с обьектами событий по услугам
18. Электронные очереди (слоты потока, расписания и тикеты)
19. Работа с джоинами суьтектами (отделениями/филиалами)
20. Получение кнопки для оплаты через Liqpay
21. Работа со странами
22. Загрузка данных по задачам
23. Получение списка бизнес процессов к которым у пользователя есть доступ
24. Получение расписаний включений
25. Добавление/изменение расписания включений
26. Удаление расписания включений
27. Получение расписаний исключений
28. Добавление/изменение расписания исключения
29. Удаление расписания исключений
30. Работа с файлами-шаблонами
31. Получение активных тикетов
32. Получение списка ID пользовательских тасок по номеру заявки
33. Получение количества записей HistoryEvent_Service для сервиса по регионам
34. Аплоад(upload) и прикрепление текстовго файла в виде атачмента к таске Activiti
35. Электронная эскалация
36. Поиск заявок по тексту (в значениях полей без учета регистра)
37. Получения ключа для аутентификации
38. Вызов сервиса уточнения полей формы
39. Вызов сервиса ответа по полям требующим уточнения
40. Получеение и установка прав доступа к rest сервисам

iGov.ua APIs

Mandatory HTTP Headers

Name	Value
Content-Type	application/json
Accept	application/json
Authorization	Basic ...

Как проверить работоспособность запроса:

Для этого можно воспользоваться программой Fiddler http://www.telerik.com/fiddler или аналогами.
В ней есть вкладка Composer с помощью которой можно отправлять запросы к API.
Нужно указать три обязательных заголовка:

Content-Type:  application/json
Accept: application/json
Authorization: Basic [login:password] закодированные в формате base64

Чтобы закодировать login:password в формат base64 можно воспользоваться онлайн генератором: https://www.base64encode.org/
Также можно ловить запросы отправляемые node.js на сервер. Вот тут описано как: http://stackoverflow.com/questions/17383351/how-to-capture-http-messages-from-request-node-library-with-fiddler

1. Аутентификация пользователя

Логин пользователя:

↑Up

HTTP Metod: POST

HTTP Context: https://server:port/wf/service/auth/login

Name	Value
Content-Type	application/x-www-form-urlencoded

sLogin - Логин пользователя
sPassword - Пароль пользователя

Request:

    sLogin=user&sPassword=password

Response:

	{"session":"true"}

где:
true - Пользователь авторизирован
false - Имя пользователя или пароль не корректны

Логаут пользователя (наличие cookie JSESSIONID):

↑Up

HTTP Metod: POST/DELETE

HTTP Context: https://server:port/wf/service/auth/logout

Response:

	{"session":"97AE7CA414A5DA85749FE379CC843796"}

2. Activiti

Запуск процесса Activiti:

↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/rest/start-process/{key}

key - Ключ процесса
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Request:

https://test.region.igov.org.ua/wf/service/rest/start-process/citizensRequest

Response:

	{
		"id":"31"
	}

Загрузка задач из Activiti:

↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/rest/tasks/{assignee}

assignee - Владелец
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Request:

https://test.region.igov.org.ua/wf/service/rest/tasks/kermit

Response:

	[                                                
  	  {
    		"delegationState": "RESOLVED",             
		    "id": "38",                                  
		    "name": "Первый процесс пользователя kermit",
		    "description": "Описание процесса",           
		    "priority": 51,                               
		    "owner": "kermit-owner",                      
		    "assignee": "kermit-assignee",                
		    "processInstanceId": "12",                   
		    "executionId": "1",                           
		    "createTime": "2015-04-13 00:51:34.527",      
		    "taskDefinitionKey": "task-definition",       
		    "dueDate": "2015-04-13 00:51:36.527",        
		    "category": "my-category",                    
		    "parentTaskId": "2",                          
		    "tenantId": "diver",                          
		    "formKey": "form-key-12",                     
		    "suspended": true,                            
		    "processDefinitionId": "21"                   
	  }
	]

Загрузка каталога сервисов из Activiti:

↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/rest/process-definitions

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Request:

https://test.region.igov.org.ua/wf/service/rest/process-definitions

Response:

	[											                            
          {
    		"id": "CivilCardAccountlRequest:1:9",                            
		    "category": "http://www.activiti.org/test",                       
		    "name": "Видача картки обліку об’єкта торговельного призначення", 
		    "key": "CivilCardAccountlRequest",                                
		    "description": "Описание процесса",                               
		    "version": 1,                                                     
		    "resourceName": "dnepr-2.bpmn",                                   
		    "deploymentId": "1",                                            
		    "diagramResourceName": "dnepr-2.CivilCardAccountlRequest.png",   
		    "tenantId": "diver",                                              
		    "suspended": true                                                 
	   }
	]

####6. Загрузки прикрепленного к заявке файла из постоянной базы ↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/rest/download_file_from_db?taskId=XXX&attachmentId=XXX&nFile=XXX

{taskId} - ид задачи
{attachmentID} - ID прикрепленного файла
{nFile} - порядковый номер прикрепленного файла
{nID_Subject} - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/rest/file/download_file_from_db?taskId=82596&attachmentId=6726532&nFile=7

####7. Работа с мерчантами ↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/merchant/getMerchants - получить весь список обьектов мерчантов

Response

	[
		{
			"nID":1
			,"sID":"Test_sID"
			,"sName":"Test_sName"
			,"sPrivateKey":"test_sPrivateKey"
			,"sURL_CallbackStatusNew":"test_sURL_CallbackStatusNew"
			,"sURL_CallbackPaySuccess":"test_sURL_CallbackPaySuccess"
			,"nID_SubjectOrgan":1
		}
		,{
			"nID":2
			,"sID":"i10172968078"
			,"sName":"igov test"
			,"sPrivateKey":"BStHb3EMmVSYefW2ejwJYz0CY6rDVMj1ZugJdZ2K"
			,"sURL_CallbackStatusNew":"test_sURL_CallbackStatusNew"
			,"sURL_CallbackPaySuccess":"test_sURL_CallbackPaySuccess"
			,"nID_SubjectOrgan":1
		}
	]

Пример: https://test.igov.org.ua/wf/service/merchant/getMerchants

HTTP Metod: GET HTTP Context: https://server:port/wf/service/merchant/getMerchant - получить обьект мерчанта

sID - ID-строка мерчанта(публичный ключ)

Response

	{
		"nID":1
		,"sID":"Test_sID"
		,"sName":"Test_sName"
		,"sPrivateKey":"test_sPrivateKey"
		,"sURL_CallbackStatusNew":"test_sURL_CallbackStatusNew"
		,"sURL_CallbackPaySuccess":"test_sURL_CallbackPaySuccess"
		,"nID_SubjectOrgan":1
	}

Пример: https://test.igov.org.ua/wf/service/merchant/getMerchant?sID=i10172968078

HTTP Metod: DELETE

HTTP Context: http://server:port/wf/service/merchant/removeMerchant - удалить мерчанта

Name	Value
Content-Type	application/x-www-form-urlencoded

sID - ID-строка мерчанта(публичный ключ)

Response

Status 200

Пример: https://test.igov.org.ua/wf/service/merchant/removeMerchant?sID=i10172968078

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/merchant/setMerchant - обновить информацию мерчанта

Name	Value
Content-Type	application/x-www-form-urlencoded

nID - ID-номер мерчанта(внутренний) //опциональный (если не задан или не найден - будет добавлена запись)
sID - ID-строка мерчанта(публичный ключ) //опциональный (если не задан или не найден - будет добавлена запись)
sName - строковое название мерчанта //опциональный (при добавлении записи - обязательный)
sPrivateKey - приватный ключ мерчанта //опциональный (при добавлении записи - обязательный)
nID_SubjectOrgan - ID-номер субьекта-органа мерчанта(может быть общий субьект у нескольких мерчантов) //опциональный
sURL_CallbackStatusNew - строка-URL каллбэка, при новом статусе платежа(проведении проплаты) //опциональный
sURL_CallbackPaySuccess - строка-URL каллбэка, после успешной отправки платежа //опциональный

Response

	{
		"nID":1
		,"sID":"Test_sID"
		,"sName":"Test_sName22"
		,"sPrivateKey":"test_sPrivateKey"
		,"sURL_CallbackStatusNew":"test_sURL_CallbackStatusNew"
		,"sURL_CallbackPaySuccess":"test_sURL_CallbackPaySuccess"
		,"nID_SubjectOrgan":1
	}

Примеры обновления: https://test.igov.org.ua/wf/service/merchant/setMerchant?sID=Test_sID&sName=Test_sName2 https://test.igov.org.ua/wf/service/merchant/setMerchant?nID=1&sName=Test_sName22 Пример добавления: https://test.igov.org.ua/wf/service/merchant/setMerchant?sID=Test_sID3&sName=Test_sName3&sPrivateKey=121212

####8. Бэкап/восстановление данных таблиц сервисов и мест ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getServicesAndPlacesTables - Скачать данные в виде json

Name	Value
Content-Type	application/json

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/downloadServicesAndPlacesTables - Скачать данные в json файле

Name	Value
Content-Disposition	attachment

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/services/setServicesAndPlacesTables - Загрузить в виде json (в теле POST запроса)

Name	Value
Content-Type	application/json

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/services/uploadServicesAndPlacesTables - Загрузить из json файла

Name	Value
Content-Type	application/json

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример страницы формы загрузки из файла:

<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/wf/service/services/uploadServicesAndPlacesTables">
File to upload: <input type="file" name="file"><br /> <input type="submit"
value="Upload"> Press here to upload the file!
</form>
</body>
</html>

####9. Работа с документами ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocument - получение документа по ид документа

nID - ИД-номер документа
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getDocument?nID=1

Response

{
	"sDate_Upload":"2015-01-01",
	"sContentType":"text/plain",
	"contentType":"text/plain",
	"nID":1,
	"sName":"Паспорт",
	"oDocumentType":{"nID":0,"sName":"Другое"},
	"sID_Content":"1",
	"oDocumentContentType":{"nID":2,"sName":"text/plain"},
	"sFile":"dd.txt",
	"oDate_Upload":1420063200000,
	"sID_Subject_Upload":"1",
	"sSubjectName_Upload":"ПриватБанк",
	"oSubject_Upload":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк", "sLabelShort":"ПриватБанк"},
	 "oSubject":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк","sLabelShort":"ПриватБанк"}
 }

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentContent - получение контента документа по ид документа

nID - ИД-номер документа
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getDocumentContent?nID=1

Response КОНТЕНТ ДОКУМЕНТА В ВИДЕ СТРОКИ

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentFile - получение документа в виде файла по ид документа

nID - ИД-номер документа
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getDocumentFile?nID=1

Response ЗАГРУЖЕННЫЙ ФАЙЛ

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentAbstract - получение документа в виде файла

sID - строковой ID документа (параметр обязателен)
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя) (параметр опционален)
nID_DocumentOperator_SubjectOrgan - определяет класс хэндлера который будет обрабатывать запрос (параметр опционален)
nID_DocumentType - определяет тип документа, например 0 - "Квитанція про сплату", 1 - "Довідка про рух по картці (для візових центрів)" (параметр опционален)
sPass - пароль (параметр опционален)

Пример: https://test.igov.org.ua/wf/service/services/getDocumentAbstract?sID=150826SV7733A36E803B

Response ЗАГРУЖЕННЫЙ ФАЙЛ

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocuments - получение списка загруженных субъектом документов

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getDocuments?nID_Subject=2

Response

[
	{
	"sDate_Upload":"2015-01-01",
	"sContentType":"text/plain",
	"contentType":"text/plain",
	"nID":1,
	"sName":"Паспорт",
	"oDocumentType":{"nID":0,"sName":"Другое"},
	"sID_Content":"1",
	"oDocumentContentType":{"nID":2,"sName":"text/plain"},
	"sFile":"dd.txt",
	"oDate_Upload":1420063200000,
	"sID_Subject_Upload":"1",
	"sSubjectName_Upload":"ПриватБанк",
	"oSubject_Upload":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк", "sLabelShort":"ПриватБанк"},
	 "oSubject":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк","sLabelShort":"ПриватБанк"}
         },
         {
	"sDate_Upload":"2015-01-01",
	"sContentType":"text/plain",
	"contentType":"text/plain",
	"nID":2,
	"sName":"Паспорт",
	"oDocumentType":{"nID":0,"sName":"Другое"},
	"sID_Content":"2",
	"oDocumentContentType":{"nID":2,"sName":"text/plain"},
	"sFile":"dd.txt",
	"oDate_Upload":1420063200000,
	"sID_Subject_Upload":"1",
	"sSubjectName_Upload":"ПриватБанк",
	"oSubject_Upload":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк", "sLabelShort":"ПриватБанк"},
	 "oSubject":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк","sLabelShort":"ПриватБанк"}
         }
]

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentAccessByHandler - получение контента документа по коду доступа,оператору, типу документа и паролю

sCode_DocumentAccess - код доступа документа
nID_DocumentOperator_SubjectOrgan - код органа(оператора)
nID_DocumentType - типа документа (опциональный)
sPass - пароль для доступа к документу (опциональный, пока только для документов у которы sCodeType=SMS)

Пример: https://test.igov.org.ua/wf/service/services/getDocumentAccessByHandler?sCode_DocumentAccess=2&nID_DocumentOperator_SubjectOrgan=2&sPass=123&nID_DocumentType=1

Response КОНТЕНТ ДОКУМЕНТА В ВИДЕ СТРОКИ

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/services/setDocument - сохранение документа

sID_Subject_Upload - ИД-строка субъекта, который загрузил документ
sSubjectName_Upload - строка-название субъекта, который загрузил документ (временный парметр, будет убран)
sName - строка-название документа
sFile - строка-название и расширение файла
nID_DocumentType - ИД-номер типа документа
sDocumentContentType - строка-тип контента документа
soDocumentContent - контект в виде строки-обьекта
nID_Subject - ИД-номер субъекта документа (владельца) ????????????????????????????????????

Пример: https://test.igov.org.ua/wf/service/services/setDocument?sID_Subject_Upload=123&sSubjectName_Upload=Vasia&sName=Pasport&sFile=file.txt&nID_DocumentType=1&sDocumentContentType=application/zip&soDocumentContent=ffffffffffffffffff&nID_Subject=1

Response ИД ДОКУМЕНТА

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/services/setDocumentFile - сохранение документа в виде файла (контент файла шлется в теле запроса)

sID_Subject_Upload - ИД-строка субъекта, который загрузил документ
sSubjectName_Upload - строка-название субъекта, который загрузил документ (временный парметр, нужно убрать его)
sName - строка-название документа
nID_DocumentType - ИД-номер типа документа
sDocumentContentType - строка-тип контента документа
soDocumentContent - контент в виде строки-обьекта
nID_Subject - ИД-номер субъекта документа (владельца)????????????????????????????????????
oFile - обьект файла (тип MultipartFile)

Response ИД ДОКУМЕНТА

ТИПЫ ДОКУМЕНТОВ

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentTypes

получение списка всех "нескрытых" типов документов, т.е. у которых поле bHidden=false

Пример: https://test.igov.org.ua/wf/service/services/getDocumentTypes

Response

[
	{"nID":0,"sName":"Другое", "bHidden":false},
	{"nID":1,"sName":"Справка", "bHidden":false},
	{"nID":2,"sName":"Паспорт", "bHidden":false}
]

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/setDocumentType - добавить/изменить запись типа документа параметры:

nID -- ид записи (число)
sName -- название записи (строка)
bHidden -- скрывать/не скрывать (при отдаче списка всех записей, булевское, по умолчанию = false)

Если запись с ид=nID не будет найдена, то создастся новая запись (с автогенерируемым nID), иначе -- обновится текущая.

примеры:

создать новый тип: https://test.igov.org.ua/wf/service/services/setDocumentType?nID=100&sName=test

ответ: {"nID":20314,"sName":"test", , "bHidden":false}

изменить (взять ид из предыдущего ответа): https://test.igov.org.ua/wf/service/services/setDocumentType?nID=20314&sName=test2

ответ: {"nID":20314,"sName":"test2", "bHidden":false}

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/removeDocumentType - удаление записи по ее ид параметры: *nID -- ид записи

Если запись с ид=nID не будет найдена, то вернется ошибка 403. Record not found, иначе -- запись удалится.

пример: https://test.igov.org.ua/wf/service/services/removeDocumentType?nID=20314

ответ: 200 ok

ТИПЫ КОНТЕНТА ДОКУМЕНТОВ

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentContentTypes - получение списка типов контента документов

Пример: https://test.igov.org.ua/wf/service/services/getDocumentContentTypes

Response

[
	{"nID":0,"sName":"application/json"},
	{"nID":1,"sName":"application/xml"},
	{"nID":2,"sName":"text/plain"},
	{"nID":3,"sName":"application/jpg"}
]

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/setDocumentContentType - добавить/изменить запись типа контента документа параметры:

*nID -- ид записи

*sName -- название записи

Если запись с ид=nID не будет найдена, то создастся новая запись (с автогенерируемым nID), иначе -- обновится текущая.

примеры:

создать новый тип: https://test.igov.org.ua/wf/service/services/setDocumentContentType?nID=100&sName=test

ответ: {"nID":20311,"sName":"test"}

изменить (взять ид из предыдущего ответа): https://test.igov.org.ua/wf/service/services/setDocumentContentType?nID=20311&sName=test2

ответ: {"nID":20311,"sName":"test2"}

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/removeDocumentContentType - удаление записи по ее ид параметры: *nID -- ид записи

Если запись с ид=nID не будет найдена, то вернется ошибка 403. Record not found, иначе -- запись удалится.

пример: https://test.igov.org.ua/wf/service/services/removeDocumentContentType?nID=20311

ответ: 200 ok

####10. Работа с субъектами ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/subject/syncSubject - получение субъекта, если таков найден, или добавление субъекта в противном случае

От клиента ожидается ОДИН и только ОДИН параметр из нижеперечисленных

nID - ИД-номер субъекта
sINN - строка-ИНН (субъект - человек)
sOKPO - строка-ОКПО (субъек - организация)
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Примеры:

https://test.igov.org.ua/wf/service/subject/syncSubject?sINN=34125265377

https://test.igov.org.ua/wf/service/subject/syncSubject?sOKPO=123

https://test.igov.org.ua/wf/service/subject/syncSubject?nID=1

Response

{
	"nID":150,
	"sID":"34125265377",
	"sLabel":null,
	"sLabelShort":null
}

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getDocumentOperators - получение всех операторов(органов) которые имею право доступа к документу

Примеры: https://test.igov.org.ua/wf/service/services/getDocumentOperators

Response

[
    {
        "nID_SubjectOrgan": 2,
        "sHandlerClass": "org.wf.dp.dniprorada.model.document.DocumentAccessHandler_IGov",
        "nID": 1,
        "sName": "iGov"
    }
]

####11. Предоставление и проверка доступа к документам ↑Up

HTTP Metod: POST

**HTTP Context: https://seriver:port/wf/service/setDocumentLink - запись на доступ, с генерацией и получением уникальной ссылки на него

nID_Document - ИД-номер документа
sFIO - ФИО, кому доступ
sTarget - цель получения доступа
sTelephone - телефон того, кому доступ предоставляется
nDays - число милисекунд, на которое предоставляется доступ
sMail - эл. почта того, кому доступ предоставляется
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Response

	[				        //[0..N]
	{"name":"sURL",   //[1..1]
	 "value":"https://e-gov.org.ua/index#nID_Access=4345&sSecret=JHg3987JHg3987JHg3987" //[1..1]
	}  
	]

HTTP Metod: POST

**HTTP Context: https://seriver:port/wf/service/getDocumentLink - проверка доступа к документу и получения данных о нем, если доступ есть

nID_Document - ИД-номер документа
sSecret - секретный ключ
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Response

HTTP STATUS 200

	[				        //[0..N]
{	
	"nID":4355
	,"nID_Document":53245
	,"sDateCreate":"2015-05-05 22:32:24.425"
	,"nMS":3523
	,"sFIO":"Вася Пупкин"
	,"sTarget":"По прикколу"
	,"sTelephone":"001 354 3456"
	,"sMail":"vasya@i.ua" 
}
	]

Если доступа нет, возвращается HTTP STATUS 403 Если доступ есть, но секрет не совпадает, возвращается HTTP STATUS 403 Если доступ просрочен, возвращается HTTP STATUS 403 Если возникла исключительная ситуация, возвращается HTTP STATUS 400. В заголовок ответа добавляется параметр Reason, в котором описана причина возникновения ситуации.

HTTP Metod: POST

**HTTP Context: https://seriver:port/wf/service/getDocumentAccess - Получение подтверждения на доступ к документу(с отсылкой СМС ОТП-паролем на телефон))

nID_Document - ИД-номер документа
sSecret - секретный ключ
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Response

	[				        //[0..N]
	{"name":"sURL",   //[1..1]
	 "value":"https://seriver:port/index#nID_Access=4345&sSecret=JHg3987JHg3987JHg3987" //[1..1]
	}  
	]

HTTP Metod: POST

**HTTP Context: https://seriver:port/wf/service/setDocumentAccess - Установка подтверждения на доступ к документу, по введенному коду, из СМС-ки(ОТП-паролем), и возвратом уникальной разовой ссылки на докуемнт.

nID_Access - ид доступа
sSecret - секретный ключ
sAnswer - ответ (введенный пользователем ОТП-пароль из СМС)
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Response

	[				        //[0..N]
	{"name":"sURL",   //[1..1]
	 "value":"https://seriver:port/index#nID_Access=4345&sSecret=JHg3987JHg3987JHg3987" //[1..1]
	}  
	]

####12. Работа с сообщениями ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/messages/getMessage - получение массива сообщений

Примеры:

https://test.igov.org.ua/wf/service/messages/getMessages

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Response:

[
	{
		"nID":76,"sHead":"Закликаю владу перевести цю послугу в електронну форму!"
		,"sBody":"Дніпропетровськ - Видача витягу з технічної документації про нормативну грошову оцінку земельної ділянки"
		,"sDate":"2015-06-03 22:09:16.536"
		,"nID_Subject":0
		,"sMail":"bvv4ik@gmail.com"
		,"sContacts":""
		,"sData":""
		,"oSubjectMessageType": {
			"sDescription": "Просьба добавить услугу",
			"nID": 0,
			"sName": "ServiceNeed"
		}
	}
]

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/messages/getMessage - получение сообщения

nID - ИД-номер сообщения

Примеры: https://test.igov.org.ua/wf/service/messages/getMessage?nID=76

nID - ID сообщения

Ответ:

{
	"nID":76
	,"sHead":"Закликаю владу перевести цю послугу в електронну форму!"
	,"sBody":"Дніпропетровськ - Видача витягу з технічної документації про нормативну грошову оцінку земельної ділянки"
	,"sDate":"2015-06-03 22:09:16.536"
	,"nID_Subject":0
	,"sMail":"bvv4ik@gmail.com"
	,"sContacts":""
	,"sData":""
	,"oSubjectMessageType": {
		"sDescription": "Просьба добавить услугу",
		"nID": 0,
		"sName": "ServiceNeed"
	}
}

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/messages/setMessage - сохранение сообщения

sHead - Строка-заглавие сообщения
sBody - Строка-тело сообщения
nID_Subject ИД-номер субьекта (автора) //опционально (добавляется в запрос автоматически после аутентификации пользователя)
sMail - Строка электронного адреса автора //опционально
sContacts - Строка контактов автора //опционально
sData - Строка дополнительных данных автора //опционально
nID_SubjectMessageType - ИД-номер типа сообщения //опционально (по умолчанию == 0)
nID_Protected - номер заявки, опционально, защищенный по алгоритму Луна
sID_Rate -- оценка, опционально. сейчас должно содержать число от 1 до 5

nID_SubjectMessageType: nID;sName;sDescription 0;ServiceNeed;Просьба добавить услугу 1;ServiceFeedback;Отзыв о услуге

При заданных обоих параметрах nID_Protected и sID_Rate - обновляется поле nRate в записи сущности HistoryEvent_Service, которая находится по nID_Protected без последней цифры, при этом приходящее значение из параметра sID_Rate должно содержать число от 1 до 5. т.е. возможные ошибки:

nID_Protected некорректное -- ошибка 403. CRC Error
sID_Rate некорректное (не число или не в промежутке от 1 до 5) -- ошибка 403. Incorrect sID_Rate
запись заявки (по nID_Protected без последней цифры) не найдена -- ошибка 403. Record not found проверить запись HistoryEvent_Service можно через сервис \sevices\getHistoryEvent_Service?nID_Protected=xxx (link: 17. Работа с обьектами событий по услугам)

Примеры: https://test.igov.org.ua/wf/service/messages/setMessage?sHead=name&sBody=body&sMail=a@a.a

Ответ: Status 200 если Ok

####13. Работа с историей (Мой журнал) ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getHistoryEvent - получение документа по ид документа

nID - ИД-номер документа
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getHistoryEvent?nID=1

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getHistoryEvents - загрузка событий

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)????????

Пример: https://test.igov.org.ua/wf/service/services/getHistoryEvents?nID_Subject=3

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/services/setHistoryEvent - сохранение события

nID_Subject - ИД-строка субъекта, который загрузил документ (необязательное поле)???????????????????????????????????
nID_HistoryEventType - ИД-номер типа документа (необязательное поле)
sEventName - строка - кастомное описание документа (необязательное поле)
sMessage - строка - сохраняемое содержимое (обязательное поле)

####14. Аплоад(upload) и прикрепление файла в виде атачмента к таске Activiti ↑Up

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/rest/file/upload_file_as_attachment - Аплоад(upload) и прикрепление файла в виде атачмента к таске Activiti

taskId - ИД-номер таски
description - описание
file - в html это имя элемента input типа file - . в HTTP заголовках - Content-Disposition: form-data; name="file" ...
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: http://test.igov.org.ua/wf/service/rest/file/upload_file_as_attachment?taskId=68&description=ololo"

Ответ без ошибок:

{"taskId":"38","processInstanceId":null,"userId":"kermit","name":"jmt.png","id":"45","type":"image/png;png","description":"SomeDocumentDescription","time":1433539278957,"url":null} 
ID созданного attachment - "id":"45"

Ответ с ошибкой:

{"code":"SYSTEM_ERR","message":"Cannot find task with id 384"}

####15. Работа с каталогом сервисов ↑Up

HTTP Context: http://server:port/wf/service/services/getServicesTree - Получение дерева сервисов

HTTP Metod: GET

sFind - фильтр по имени сервиса (не обязательный параметр). Если задано, то производится фильтрация данных - возвращаются только сервиса в имени которых встречается значение этого параметра, без учета регистра.
asID_Place_UA - фильтр по ID места (мест), где надается услуга. Поддерживаемие ID: 3200000000 (КИЇВСЬКА ОБЛАСТЬ/М.КИЇВ), 8000000000 (М.КИЇВ). Если указан другой ID, фильтр не применяется.
bShowEmptyFolders - Возвращать или нет пустые категории и подкатегории (опциональный, по умолчанию false)
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Дополнительно:

Если general.bTest = false, сервисы, имя которых начинается с "_", не вовращаются.

Пример: https://test.igov.org.ua/wf/service/services/getServicesTree?asID_Place_UA=3200000000,8000000000

Ответ:

[{"nID":1,"sID":"Citizen","sName":"Громадянам","nOrder":1,"aSubcategory":[{"nID":1,"sName":"Будівництво, нерухомість, земля","sID":"Build","nOrder":1,"aService":[{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":6,"sName":"Видача відомостей з документації, що включена до місцевого фонду документації із землеустрою.","nOrder":6,"nSub":1},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":8,"sName":"Надання довідки про перебування на квартирному обліку при міськвиконкомі за місцем проживання та в житлово-будівельному кооперативі.","nOrder":8,"nSub":1},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":9,"sName":"Надання довідки про перебування на обліку бажаючих отримати земельну ділянку під індивідуальне будівництво","nOrder":9,"nSub":0},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":10,"sName":"Видача витягу з технічної документації про нормативну грошову оцінку земельної ділянки","nOrder":10,"nSub":2},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":11,"sName":"Надання відомостей з Державного земельного кадастру у формі витягу з Державного земельного кадастру про земельну ділянку","nOrder":11,"nSub":0},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":12,"sName":"Присвоєння поштової адреси об’єкту нерухомого майна","nOrder":12,"nSub":1},{"sSubjectOperatorName":"Міська Рада","subjectOperatorName":"Міська Рада","nID":13,"sName":"Видача довідок про перебування на квартирному обліку","nOrder":13,"nSub":0}]

HTTP Context: http://server:port/wf/service/services/getService - Получение сервиса

HTTP Metod: GET

nID - ИД-номер сервиса
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getService?nID=1

Ответ:

{"sSubjectOperatorName":"МВС","subjectOperatorName":"МВС","nID":1,"sName":"Отримати довідку про несудимість","nOrder":1,"aServiceData":[{"nID":1,"nID_City":{"nID":2,"sName":"Кривий Ріг","nID_Region":{"nID":1,"sName":"Дніпропетровська"}},"nID_ServiceType":{"nID":1,"sName":"Внешняя","sNote":"Пользователь переходит по ссылке на услугу, реализованную на сторонней платформе"},"oSubject_Operator":{"nID":1,"oSubject":{"nID":1,"sID":"ПАО","sLabel":"ПАО ПриватБанк","sLabelShort":"ПриватБанк"},"sOKPO":"093205","sFormPrivacy":"ПАО","sName":"ПриватБанк","sNameFull":"Банк ПриватБанк"},"oData":"{}","sURL":"https://dniprorada.igov.org.ua","bHidden":false}],"sInfo":"","sFAQ":"","sLaw":"","nSub":0}

HTTP Context: http://server:port/wf/service/services/setService - Изменение сервиса. Можно менять/добавлять, но не удалять данные внутри сервиса, на разной глубине вложенности. Передается json в теле POST запроса в том же формате, в котором он был в getService.

HTTP Metod: POST

Вовращает: HTTP STATUS 200 + json представление сервиса после изменения. Чаще всего то же, что было передано в теле POST запроса + сгенерированные id-шники вложенных сущностей, если такие были.

Пример: https://test.igov.org.ua/wf/service/services/setService

{
    "sSubjectOperatorName": "МВС",
    "subjectOperatorName": "МВС",
    "nID": 1,
    "sName": "Отримати довідку про несудимість",
    "nOrder": 1,
    "aServiceData": [
        {
            "nID": 1,
            "nID_City": {
                "nID": 2,
                "sName": "Кривий Ріг",
                "nID_Region": {
                    "nID": 1,
                    "sName": "Дніпропетровська"
                }
            },
            "nID_ServiceType": {
                "nID": 1,
                "sName": "Внешняя",
                "sNote": "Пользователь переходит по ссылке на услугу, реализованную на сторонней платформе"
            },
            "oSubject_Operator": {
                "nID": 1,
                "oSubject": {
                    "nID": 1,
                    "sID": "ПАО",
                    "sLabel": "ПАО ПриватБанк",
                    "sLabelShort": "ПриватБанк"
                },
                "sOKPO": "093205",
                "sFormPrivacy": "ПАО",
                "sName": "ПриватБанк",
                "sNameFull": "Банк ПриватБанк"
            },
            "oData": "{}",
            "sURL": "https://dniprorada.igov.org.ua",
            "bHidden": false
        }
    ],
    "sInfo": "",
    "sFAQ": "",
    "sLaw": "",
    "nSub": 0
}

Ответ:

{
    "sSubjectOperatorName": "МВС",
    "subjectOperatorName": "МВС",
    "nID": 1,
    "sName": "Отримати довідку про несудимість",
    "nOrder": 1,
    "aServiceData": [
        {
            "nID": 1,
            "nID_City": {
                "nID": 2,
                "sName": "Кривий Ріг",
                "nID_Region": {
                    "nID": 1,
                    "sName": "Дніпропетровська"
                }
            },
            "nID_ServiceType": {
                "nID": 1,
                "sName": "Внешняя",
                "sNote": "Пользователь переходит по ссылке на услугу, реализованную на сторонней платформе"
            },
            "oSubject_Operator": {
                "nID": 1,
                "oSubject": {
                    "nID": 1,
                    "sID": "ПАО",
                    "sLabel": "ПАО ПриватБанк",
                    "sLabelShort": "ПриватБанк"
                },
                "sOKPO": "093205",
                "sFormPrivacy": "ПАО",
                "sName": "ПриватБанк",
                "sNameFull": "Банк ПриватБанк"
            },
            "oData": "{}",
            "sURL": "https://dniprorada.igov.org.ua",
            "bHidden": false
        }
    ],
    "sInfo": "",
    "sFAQ": "",
    "sLaw": "",
    "nSub": 0
}

HTTP Context: http://server:port/wf/service/services/removeService - Удаление сервиса.

HTTP Metod: DELETE

nID - ИД-номер сервиса
bRecursive (не обязательно, по умолчанию false) - Удалять рекурсивно все данные связанные с сервисом. Если false, то при наличии вложенных сущностей, ссылающихся на эту, сервис удален не будет.
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Вовращает:

HTTP STATUS 200 - удаление успешно. HTTP STATUS 304 - не удалено.

Пример 1: https://test.igov.org.ua/wf/service/services/removeService?nID=1

Ответ 1: HTTP STATUS 304

Пример 2: https://test.igov.org.ua/wf/service/services/removeService?nID=1&bRecursive=true

Ответ 2: HTTP STATUS 200

{
    "code": "success",
    "message": "class org.wf.dp.dniprorada.model.Service id: 1 removed"
}

HTTP Context: http://server:port/wf/service/services/removeServiceData - Удаление сущности ServiceData.

HTTP Metod: DELETE

nID - идентификатор ServiceData
bRecursive (не обязательно, по умолчанию false) - Удалять рекурсивно все данные связанные с ServiceData. Если false, то при наличии вложенных сущностей, ссылающихся на эту, ServiceData удалена не будет.
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Вовращает:

HTTP STATUS 200 - удаление успешно. HTTP STATUS 304 - не удалено.

Пример: https://test.igov.org.ua/wf/service/services/removeServiceData?nID=1&bRecursive=true

Ответ: HTTP STATUS 200

{
    "code": "success",
    "message": "class org.wf.dp.dniprorada.model.ServiceData id: 1 removed"
}

HTTP Context: http://server:port/wf/service/services/removeSubcategory - Удаление подкатегории.

HTTP Metod: DELETE

nID - идентификатор подкатегории.
bRecursive (не обязательно, по умолчанию false) - Удалять рекурсивно все данные связанные с подкатегорией. Если false, то при наличии вложенных сущностей, ссылающихся на эту, подкатегория удалена не будет.
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Вовращает:

HTTP STATUS 200 - удаление успешно. HTTP STATUS 304 - не удалено.

Пример 1: https://test.igov.org.ua/wf/service/services/removeSubcategory?nID=1

Ответ 1: HTTP STATUS 304

Пример 2: https://test.igov.org.ua/wf/service/services/removeSubcategory?nID=1&bRecursive=true

Ответ 2: HTTP STATUS 200

{
    "code": "success",
    "message": "class org.wf.dp.dniprorada.model.Subcategory id: 1 removed"
}

HTTP Context: http://server:port/wf/service/services/removeCategory - Удаление категории.

HTTP Metod: DELETE

nID - идентификатор подкатегории.
bRecursive (не обязательно, по умолчанию false) - Удалять рекурсивно все данные связанные с категорией. Если false, то при наличии вложенных сущностей, ссылающихся на эту, категория удалена не будет.
nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Вовращает:

HTTP STATUS 200 - удаление успешно. HTTP STATUS 304 - не удалено.

Пример 1: https://test.igov.org.ua/wf/service/services/removeCategory?nID=1

Ответ 1: HTTP STATUS 304

Пример 2: https://test.igov.org.ua/wf/service/services/removeCategory?nID=1&bRecursive=true

Ответ 2: HTTP STATUS 200

{
    "code": "success",
    "message": "class org.wf.dp.dniprorada.model.Category id: 1 removed"
}

HTTP Context: http://server:port/wf/service/services/removeServicesTree - Удаление всего дерева сервисов и категорий.

HTTP Metod: DELETE

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Вовращает:

HTTP STATUS 200 - удаление успешно.

Пример 1: https://test.igov.org.ua/wf/service/services/removeServicesTree

Ответ 1: HTTP STATUS 200

{
    "code": "success",
    "message": "ServicesTree removed"
}

HTTP Context: http://server:port/wf/service/services/getPlaces - Получения дерева мест (регионов и городов).

HTTP Metod: GET

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Пример: https://test.igov.org.ua/wf/service/services/getPlaces

Ответ:

[
    {
        "nID": 1,
        "sName": "Дніпропетровська",
        "aCity": [
            {
                "nID": 1,
                "sName": "Дніпропетровськ"
            },
            {
                "nID": 2,
                "sName": "Кривий Ріг"
            }
        ]
    },
    {
        "nID": 2,
        "sName": "Львівська",
        "aCity": [
            {
                "nID": 3,
                "sName": "Львів"
            }
        ]
    },
    {
        "nID": 3,
        "sName": "Івано-Франківська",
        "aCity": [
            {
                "nID": 4,
                "sName": "Івано-Франківськ"
            },
            {
                "nID": 5,
                "sName": "Калуш"
            }
        ]
    },
    {
        "nID": 4,
        "sName": "Миколаївська",
        "aCity": []
    },
    {
        "nID": 5,
        "sName": "Київська",
        "aCity": [
            {
                "nID": 6,
                "sName": "Київ"
            }
        ]
    },
    {
        "nID": 6,
        "sName": "Херсонська",
        "aCity": [
            {
                "nID": 7,
                "sName": "Херсон"
            }
        ]
    },
    {
        "nID": 7,
        "sName": "Рівненська",
        "aCity": [
            {
                "nID": 8,
                "sName": "Кузнецовськ"
            }
        ]
    },
    {
        "nID": 8,
        "sName": "Волинська",
        "aCity": [
            {
                "nID": 9,
                "sName": "Луцьк"
            }
        ]
    }
]

HTTP Context: http://server:port/wf/service/services/setPlaces - Изменение дерева мест (регионов и городов). Можно менять регионы (не добавлять и не удалять) + менять/добавлять города (но не удалять), Передается json в теле POST запроса в том же формате, в котором он был в getPlaces.

HTTP Metod: POST

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Возвращает: HTTP STATUS 200 + json представление сервиса после изменения. Чаще всего то же, что было передано в теле POST запроса + сгенерированные id-шники вложенных сущностей, если такие были.

Пример: https://test.igov.org.ua/wf/service/services/setPlaces

[
    {
        "nID": 1,
        "sName": "Дніпропетровська",
        "aCity": [
            {
                "nID": 1,
                "sName": "Cічеслав"
            },
            {
                "nID": 2,
                "sName": "Кривий Ріг"
            }
        ]
    }
]

Ответ: HTTP STATUS 200

[
    {
        "nID": 1,
        "sName": "Дніпропетровська",
        "aCity": [
            {
                "nID": 1,
                "sName": "Cічеслав"
            },
            {
                "nID": 2,
                "sName": "Кривий Ріг"
            }
        ]
    }
]

HTTP Context: http://server:port/wf/service/services/setServicesTree - Изменение дерева категорий (с вложенными подкатегориями и сервисами). Можно менять категории (не добавлять и не удалять) + менять/добавлять (но не удалять) вложенные сущности, Передается json в теле POST запроса в том же формате, в котором он был в getServicesTree.

HTTP Metod: POST

nID_Subject - ID авторизированого субъекта (добавляется в запрос автоматически после аутентификации пользователя)

Возвращает: HTTP STATUS 200 + json представление сервиса после изменения. Чаще всего то же, что было передано в теле POST запроса + сгенерированные id-шники вложенных сущностей, если такие были.

Пример: https://test.igov.org.ua/wf/service/services/setServicesTree

[
    {
        "nID": 1,
        "sID": "Citizen",
        "sName": "Гражданин",
        "nOrder": 1,
        "aSubcategory": [
            {
                "nID": 5,
                "sName": "Праця2",
                "sID": "Work",
                "nOrder": 3,
                "aService": [
                    {
                        "nID": 3,
                        "sName": "Видача картки обліку об’єкта торговельного призначення, сфери послуг та з виробництва продуктів харчування",
                        "nOrder": 3
                    },
                    {
                        "nID": 4,
                        "sName": "Легалізація об’єднань громадян шляхом повідомлення",
                        "nOrder": 4
                    }
                ]
            }
            ]
         }
]

Ответ: HTTP STATUS 200

[
    {
        "nID": 1,
        "sID": "Citizen",
        "sName": "Гражданин",
        "nOrder": 1,
        "aSubcategory": [
            {
                "nID": 5,
                "sName": "Праця2",
                "sID": "Work",
                "nOrder": 3,
                "aService": [
                    {
                        "nID": 3,
                        "sName": "Видача картки обліку об’єкта торговельного призначення, сфери послуг та з виробництва продуктів харчування",
                        "nOrder": 3
                    },
                    {
                        "nID": 4,
                        "sName": "Легалізація об’єднань громадян шляхом повідомлення",
                        "nOrder": 4
                    }
                ]
            }
            ]
         }
]

Для добавления новой подкатегории нужно передать запрос вида:

[
  {
    "nID": 1,
    "aSubcategory": [
      {
        "sID": "Yd",
        "sName": "Yjdd",
        "nOrder": "1",
        "oCategory": {
          "nID": 1
        }
      }
    ]
  }
]

Обязательно нужно указывать внутри подкатегории ссылку на категорию, с помощью

"oCategory": {
  "nID": 1
}

Для добавления нового сервиса нужно передать запрос вида:

[
  {
    "nID": 1,
    "aSubcategory": [
      {
        "nID": 3,
        "aService": [
          {
            "sName": "service name",
            "nOrder": 10,
            "sSubjectOperatorName": "subjectOperatorName",
            "oSubcategory": {
              "nID": 3
            },
            "sInfo": "",
            "sFAQ": "",
            "sLaw": ""
          }
        ]
      }
    ]
  }
]

Обязательно нужно указывать внутри сервиса ссылку на подкатегорию, с помощью

"oSubcategory": {
  "nID": 3
}

А также обязательные поля "sInfo", "sFAQ", "sLaw" - можно с пустыми значениями.

#### 16. Получение статистики по задачам в рамках бизнес процесса ↑Up

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/rest/download_bp_timing?sID_BP_Name=XXX&sDateAt=XXX8&sDateTo=XXX

sID_BP_Name - ID бизнес процесса
sDateAt - Дата начала периода для выборки в формате yyyy-MM-dd
sDateTo - Дата окончания периода для выборки в формате yyyy-MM-dd
nRowsMax - необязательный параметр. Максимальное значение завершенных задач для возврата. По умолчанию 1000.
nRowStart - Необязательный параметр. Порядковый номер завершенной задачи в списке для возврата. По умолчанию 0.
bDetail - Необязательный параметр. Необходим ли расширенный вариант (с полями задач). По умолчанию true.

Метод возвращает .csv файл со информацией о завершенных задачах в указанном бизнес процессе за период. Формат выходного файла
Assignee - кто выполнял задачу
Start Time - Дата и время начала
Duration in millis - Длительность выполнения задачи в миллисекундах
Duration in hours - Длительность выполнения задачи в часах
Name of Task - Название задачи
Поля из FormProperty (если bDetail=true)

Пример: https://test.region.igov.org.ua/wf/service/rest/file/download_bp_timing?sID_BP_Name=lviv_mvk-1&sDateAt=2015-06-28&sDateTo=2015-07-01

Пример выходного файла

"Assignee","Start Time","Duration in millis","Duration in hours","Name of Task"
"kermit","2015-06-21:09-20-40","711231882","197","Підготовка відповіді на запит: пошук документа"

#### 17. Работа с обьектами событий по услугам ↑Up
**HTTP Metod: GET**

HTTP Context: https://server:port/wf/service/services/getHistoryEvent_Service?nID_Protected=ххх* получает объект события по услуге, параметры:

nID_Protected - проверочное число-ид

сначала проверяется корректность числа nID_Protected, где последняя цифра - это последний разряд контрольной суммы (по алгоритму Луна) для всего числа без нее.

если не совпадает -- возвращается ошибка "CRC Error" (код состояния HTTP 403)
если совпадает -- ищется запись по nID_Process = nID_Protected без последней цифры (берется последняя по дате добавления)
Если не найдена запись, то возвращает объект ошибки со значением "Record not found" (код состояния HTTP 403)
иначе возвращает обьект

пример: http://test.igov.org.ua/wf/service/services/getHistoryEvent_Service?nID_Protected=11

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/services/addHistoryEvent_Service?nID_Task=xxx&sStatus=xxx&nID_Subject=xxx*

добавляет объект события по услуге, параметры:

nID_Process - ИД-номер задачи (long)
nID_Subject - ИД-номер (long)
sID_Status - строка-статус
sProcessInstanceName - название услуги (для Журнала событий)
nID_Service -- ид услуги (long, опционально)
nID_Region -- ид области (long, опционально)
sID_UA -- ид страны (строка, опционально)
soData - строка-объект с данными (опционально, для поддержки дополнения заявки со стороны гражданина)
sToken - строка-токена (опционально, для поддержки дополнения заявки со стороны гражданина)
sHead - строка заглавия сообщения (опционально, для поддержки дополнения заявки со стороны гражданина)
sBody - строка тела сообщения (опционально, для поддержки дополнения заявки со стороны гражданина)

при добавлении записи генерируется поле nID_Protected по принципу nID_Protected = nID_Process (ид задачи) + "контрольная цифра"

контрольная цифра -- это последний разряд суммы цифр числа по алгоритму Луна это поле используется для проверки корректности запрашиваемого ид записи (в методах get и update)

пример: http://test.igov.org.ua/wf/service/services/addHistoryEvent_Service?nID_Process=2&sID_Status=new&nID_Subject=2&sProcessInstanceName=test_bp

ответ:

{"nID":1001,"sID":null,"nID_Process":2,"nID_Subject":2,"sID_Status":"new","nID_Protected":22, "sDate":"2015-09-21 21:14:48.129","nRate":0, "soData":"[]"}

HTTP Metod: GET

HTTP Context: https://server:port/wf/service/services/updateHistoryEvent_Service?nID=xxx&sStatus=xxx*

обновляет объект события по услуге, параметры:

nID_Process - ИД-номер задачи (long)
sID_Status - строка-статус
soData - строка-объект с данными (опционально, для поддержки дополнения заявки со стороны гражданина)
sToken - строка-токена (опционально, для поддержки дополнения заявки со стороны гражданина)
sHead - строка заглавия сообщения (опционально, для поддержки дополнения заявки со стороны гражданина)
sBody - строка тела сообщения (опционально, для поддержки дополнения заявки со стороны гражданина)

пример http://test.igov.org.ua/wf/service/services/updateHistoryEvent_Service?nID_Process=1&sID_Status=finish Также при апдейте охраняется информация о действии в Моем Журнале

запись "Ваша заявка №[nID_Process] змiнила свiй статус на [sID_Status]"
если есть параметр soData, то еще создается запись в виде:

"По заявці №[nID_Process] задане прохання уточнення: [sBody]" (если sToken не пустой) -- согласно сервису в запроса на уточнение
"По заявці №[nID_Process] дана відповідь громадянином: [sBody]" (если sToken пустой) -- согласно сервису ответа на запрос по уточнению
плюс перечисление полей из soData в формате таблицы Поле / Тип / Текущее значение

#### 18. Электронные очереди (слоты потока, расписания и тикеты) ↑Up

HTTP Context: http://server:port/wf/service/flow/getFlowSlots_ServiceData - Получение слотов по сервису сгруппированных по дням.

HTTP Metod: GET

Параметры:

nID_ServiceData - ID сущности ServiceData (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса (обязательный если нет nID_ServiceData)
bAll - если false то из возвращаемого объекта исключаются элементы, содержащие "bHasFree":false "bFree":false (опциональный, по умолчанию false)
nDays - колличество дней от сегодняшего включительно(или sDateStart, если задан), до nDays в будующее за который нужно вернуть слоты (опциональный, по умолчанию 177 - пол года)
nFreeDays - дни со слотами будут включаться в результат пока не наберется указанное кол-во свободных дней (опциональный, по умолчанию 60)
sDateStart - опциональный параметр, определяющие дату начала в формате "yyyy-MM-dd", с которую выбрать слоты. При наличии этого параметра слоты возвращаются только за указанный период(число дней задается nDays).

Пример: https://test.igov.org.ua/wf/service/flow/getFlowSlots_ServiceData?nID_ServiceData=1 или https://test.region.igov.org.ua/wf/service/flow/getSheduleFlowIncludes?sID_BP=kiev_mreo_1

Ответ: HTTP STATUS 200

{
    "aDay": [
        {
            "sDate": "2015-07-19",
            "bHasFree": true,
            "aSlot": [
                {
                    "nID": 1,
                    "sTime": "18:00",
                    "nMinutes": 15,
                    "bFree": true
                }
            ]
        },
        {
            "sDate": "2015-07-20",
            "bHasFree": true,
            "aSlot": [
                {
                    "nID": 3,
                    "sTime": "18:15",
                    "nMinutes": 15,
                    "bFree": true
                }
            ]
        }
    ]
}

Калькулируемые поля в ответе:

флаг "bFree" - является ли слот свободным? Слот считается свободным если на него нету тикетов у которых nID_Task_Activiti равен null, а у тех у которых nID_Task_Activiti = null - время создания тикета (sDateEdit) не позднее чем текущее время минус 5 минут (предопределенная константа)

флаг "bHasFree" равен true , если данных день содержит хотя бы один свободный слот.

HTTP Context: http://server:port/wf/service/flow/setFlowSlots_ServiceData - Создание или обновление тикета в указанном слоте.

HTTP Metod: POST

Параметры:

nID_FlowSlot - ID сущности FlowSlot (обязательный)
nID_Subject - ID сущнсоти Subject - субьект пользователь услуги, который подписывается на слот (обязательный)
nID_Task_Activiti - ID таски активити процесса предоставления услуги (не обязательный - вначале он null, а потом засчивается после подтверждения тикета, и создания процесса)

Пример: http://test.igov.org.ua/wf/service/flow/setFlowSlot_ServiceData

nID_FlowSlot=1
nID_Subject=2

Ответ: HTTP STATUS 200

{ "nID_Ticket": 1000 }

Поля в ответе:

поле "nID_Ticket" - ID созданной/измененной сущности FlowSlotTicket.

HTTP Context: http://server:port/wf/service/flow/buildFlowSlots - Генерация слотов на заданный интервал для заданного потока.

HTTP Metod: POST

Параметры:

nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
sDateStart - дата "начиная с такого-то момента времени", в формате "2015-06-28 12:12:56.001" (опциональный)
sDateStop - дата "заканчивая к такому-то моменту времени", в формате "2015-07-28 12:12:56.001" (опциональный)

Пример: http://test.igov.org.ua/wf/service/flow/buildFlowSlots

nID_Flow_ServiceData=1
sDateStart=2015-06-01 00:00:00.000
sDateStop=2015-06-07 00:00:00.000

Ответ: HTTP STATUS 200 + json перечисление всех сгенерированных слотов.

Ниже приведена часть json ответа:

[
    {
        "nID": 1000,
        "sTime": "08:00",
        "nMinutes": 15,
        "bFree": true
    },
    {
        "nID": 1001,
        "sTime": "08:15",
        "nMinutes": 15,
        "bFree": true
    },
    {
        "nID": 1002,
        "sTime": "08:30",
        "nMinutes": 15,
        "bFree": true
    },
...
]

Если на указанные даты слоты уже сгенерены то они не будут генерится повторно, и в ответ включаться не будут.

HTTP Context: http://server:port/wf/service/flow/clearFlowSlots - Удаление слотов на заданный интервал для заданного потока.

HTTP Metod: DELETE

Параметры:

nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
sDateStart - дата "начиная с такого-то момента времени", в формате "2015-06-28 12:12:56.001" (обязательный)
sDateStop - дата "заканчивая к такому-то моменту времени", в формате "2015-07-28 12:12:56.001" (обязательный)
bWithTickets - удалять ли слоты с тикетами, отвязывая тикеты от слотов? (опциональный, по умолчанию false)

Пример: http://test.igov.org.ua/wf/service/flow/clearFlowSlots?nID_Flow_ServiceData=1&sDateStart=2015-06-01 00:00:00.000&sDateStop=2015-06-07 00:00:00.000

Ответ: HTTP STATUS 200 + json Обьект содержащий 2 списка:

aDeletedSlot - удаленные слоты
aSlotWithTickets - слоты с тикетами. Елси bWithTickets=true то эти слоты тоже удаляются и будут перечислены в aDeletedSlot, иначе - не удаляются.

Ниже приведена часть json ответа:

{
    "aDeletedSlot": [
        {
            "nID": 1000,
            "sTime": "08:00",
            "nMinutes": 15,
            "bFree": true
        },
        {
            "nID": 1001,
            "sTime": "08:15",
            "nMinutes": 15,
            "bFree": true
        },
        ...
     ],
     "aSlotWithTickets": []
}

#### 19. Работа с джоинами субьектами (отделениями/филиалами) ↑Up
(таска: https://github.com/e-government-ua/i/issues/487)

Поля:

nID - ИД-номер автоитеррируемый (уникальный, обязательный) (long)
nID_SubjectOrgan - ИД-номер (long)
sNameRu - строка <200 символов
sNameUa - ИД-строка <200 символов
sID_Privat - ИД-строка ключ-частный <60 символов //опциональный
sID_Public - строка ключ-публичный <60 символов
sGeoLongitude - строка долготы //опциональный
sGeoLatitude - строка широты //опциональный
nID_Region - ИД-номер //опциональный
nID_City - ИД-номер //опциональный
sID_UA - ИД-строка кода классификатора КОАТУУ //опциональный

getSubjectOrganJoins - получает весь массив объектов п.2 (либо всех либо в рамках заданных в запросе nID_Region, nID_City или sID_UA)
Method: GET Параметры:

nID_SubjectOrgan - ИД-номер (в урл-е)
nID_Region - ИД-номер (в урл-е) //опциональный (только если надо задать или задан)
nID_City - ИД-номер (в урл-е) //опциональный (только если надо задать или задан)
sID_UA - ИД-строка (в урл-е) //опциональный (только если надо задать или задан)

Пример ответа:

[
	{	"nID_SubjectOrgan":32343
		,"sNameUa":"Українська мова"
		,"sNameRu":"Русский язык"
		,"sID_Privat":"12345"
		,"sID_Public":"130501"
		,"sGeoLongitude":"15.232312"
		,"sGeoLatitude":"23.234231"
		,"nID_Region":11
		,"nID_City":33
		,"sID_UA":"1"
	}
]

Пример: https://test.igov.org.ua/wf/service/services/getSubjectOrganJoins?nID_SubjectOrgan=1&sID_UA=1

setSubjectOrganJoin - добавляет/обновляет массив объектов п.2 (сопоставляя по по ИД, и связывая новые с nID_Region, nID_City или sID_UA, по совпадению их названий)
Method: POST Параметры:

nID_SubjectOrgan - ИД-номер
nID //опциональный, если добавление
sNameRu //опциональный
sNameUa //опциональный
sID_Privat //опциональный
sID_Public //опциональный, если апдейт
sGeoLongitude //опциональный
sGeoLatitude //опциональный
nID_Region //опциональный
nID_City //опциональный
sID_UA //опциональный

Пример: https://test.igov.org.ua/wf/service/services/setSubjectOrganJoin?nID_SubjectOrgan=1&sNameRu=Днепр.РОВД

removeSubjectOrganJoins - удаляет массив объектов п.2 (находя их по ИД)
Method: POST Параметры:

nID_SubjectOrgan - ИД-номер (в урл-е)
asID_Public - массив ИД-номеров (в урл-е) (например [3423,52354,62356,63434])

Пример: https://test.igov.org.ua/wf/service/services/removeSubjectOrganJoins?nID_SubjectOrgan=1&asID_Public=130505,130506,130507,130508

#### 20. Получение кнопки для оплаты через LiqPay
↑Up **Method: GET**

HTTP Context: https://server:port/wf/service/services/getPayButtonHTML_LiqPay

Параметры:

sID_Merchant - ид меранта
sSum - сумма оплаты
oID_Currency - валюта
oLanguage - язык
sDescription - описание
sID_Order - ид заказа
sURL_CallbackStatusNew - URL для отправки статуса
sURL_CallbackPaySuccess - URL для отправки ответа
nID_Subject - ид субъекта
bTest - тестовый вызов или нет

Пример: https://test.igov.org.ua/wf/service/services/getPayButtonHTML_LiqPay?sID_Merchant=i10172968078&sSum=55,00&oID_Currency=UAH&oLanguage=RUSSIAN&sDescription=test&sID_Order=12345&sURL_CallbackStatusNew=&sURL_CallbackPaySuccess=&nID_Subject=1&bTest=true

####21. Работа со странами ↑Up

HTTP Context: https://server:port/wf/service/services/setCountry

Method: GET

апдейтит элемент (если задан один из уникальных ключей) или вставляет (если не задан nID), и отдает экземпляр нового объекта.

Параметры:

nID - ИД-номер, идентификатор записи
nID_UA - ИД-номер Код, в Украинском классификаторе (уникальное)
sID_Two - ИД-строка Код-двухсимвольный, международный (уникальное, строка 2 символа)
sID_Three - ИД-строка Код-трехсимвольный, международный (уникальное, строка 3 символа)
sNameShort_UA - Назва країни, коротка, Украинская (уникальное, строка до 100 символов)
sNameShort_EN - Назва країни, коротка, англійською мовою (уникальное, строка до 100 символов)
sReference_LocalISO - Ссылка на локальный ISO-стандарт, с названием (a-teg с href) (строка до 100 символов)

Если нет ни одного параметра возвращает ошибку 403. All args are null! Если есть один из уникальных ключей, но запись не найдена -- ошибка 403. Record not found! Если кидать "новую" запись с одним из уже существующих ключем nID_UA -- то обновится существующая запись по ключу nID_UA, если будет дублироваться другой ключ -- ошибка 403. Could not execute statement (из-за уникальных констрейнтов)

HTTP Context: https://server:port/wf/service/services/getCountries

Method: GET

возвращает весь список стран (залит справочник согласно Википеции и Класифікації країн світу)

пример: https://test.igov.org.ua/wf/service/services/getCountries

HTTP Context: https://server:port/wf/service/services/getCountry

Method: GET

возвращает объект Страны по первому из 4х ключей (nID, nID_UA, sID_Two, sID_Three).

Если нет ни одного параметра возвращает ошибку 403. required at least one of parameters (nID, nID_UA, sID_Two, sID_Three)!

Eсли задано два ключа от разных записей -- вернется та, ключ который "первее" в таком порядке: nID, nID_UA, sID_Two, sID_Three.

пример: https://test.igov.org.ua/wf/service/services/getCountry?nID_UA=123

ответ:

{
"nID_UA":123,
"sID_Two":"AU",
"sID_Three":"AUS",
"sNameShort_UA":"Австралія",
"sNameShort_EN":"Australy",
"sReference_LocalISO":"ISO_3166-2:AU",
"nID":20340
}

HTTP Context: https://server:port/wf/service/services/removeCountry

Method: GET

удаляет обьект по одному из четырех ключей (nID, nID_UA, sID_Two, sID_Three) или кидает ошибку 403. Record not found!.

####22. Загрузка данных по задачам ↑Up

Method: GET

HTTP Context: https://server:port/wf/service/rest/file/downloadTasksData

Загрузка полей по задачам в виде файла.

Параметры:

sID_BP - название бизнесс процесса
sID_State_BP - состояние задачи, по умолчанию исключается из фильтра Берется из поля taskDefinitionKey задачи
saFields - имена полей для выборкы разделенных через ';', чтобы добавить все поля можно использовать - '*'
nASCI_Spliter - ASCII код для разделителя
sFileName - имя исходящего файла, по умолчанию - data_BP-bpName_.txt"
sID_Codepage - кодировка исходящего файла, по умолчанию - win1251
sDateCreateFormat - форматирование даты создания таски, по умолчанию - yyyy-MM-dd HH:mm:ss
sDateAt - начальная дата создания таски, по умолчанию - вчера
sDateTo - конечная дата создания таски, по умолчанию - сегодня
nRowStart - начало выборки для пейджирования, по умолчанию - 0
nRowsMax - размер выборки для пейджирования, по умолчанию - 1000

Поля по умолчанию, которые всегда включены в выборку:

nID_Task - "id таски"
sDateCreate - "дата создания таски" (в формате sDateCreateFormat)

Особенности обработки полей:

Если тип поля enum, то брать не его ИД пункта в энуме а именно значение Если тип поля enum, и в значении присутствует знак ";", то брать только то ту часть текста, которая находится справа от этого знака

Пример: https://test.region.igov.org.ua/wf/service/rest/file/downloadTasksData?&sID_BP=dnepr_spravka_o_doxodax&sID_State_BP=usertask1&sDateAt=2015-06-01&sDateTo=2015-08-01&saFields=${nID_Task};${sDateCreate};${area};;;0;${bankIdlastName} ${bankIdfirstName} ${bankIdmiddleName};4;${aim};${date_start};${date_stop};${place_living};${bankIdPassport};1;${phone};${email}&sID_Codepage=win1251&nASCI_Spliter=18&sDateCreateFormat=dd.mm.yyyy hh:MM:ss&sFileName=dohody.dat

Пример ответа:

1410042;16.32.2015 10:07:17;АНД (пров. Універсальний, 12);;;0;БІЛЯВЦЕВ ВОЛОДИМИР ВОЛОДИМИРОВИЧ;4;мета;16/07/2015;17/07/2015;мокешрмшгкеу;АЕ432204 БАБУШКИНСКИМ РО ДГУ УМВД 26.09.1996;1;380102030405;mendeleev.ua@gmail.com
995161;07.07.2015 05:07:27;;;;0;ДУБІЛЕТ ДМИТРО ОЛЕКСАНДРОВИЧ;4;для роботи;01/07/2015;07/07/2015;Дніпропетровська, Дніпропетровськ, вул. Донецьке шосе, 15/110;АМ765369 ЖОВТНЕВИМ РВ ДМУ УМВС УКРАЙНИ В ДНИПРОПЕТРОВСЬКИЙ ОБЛАСТИ 18.03.2002;1;;ukr_rybak@rambler.ru

#### 23. Получение списка бизнес процессов к которым у пользователя есть доступ ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/getLoginBPs?sLogin=[userId]

sLogin - ID пользователя

Метод возвращает json со списком бизнес процессов, к которым у пользователя есть доступ, в формате [ { "sID":"[process definition key]" "sName":"[process definition name]" }, { "sID":"[process definition key]" "sName":"[process definition name]" } ]

Принадлежность пользователя к процессу проверяется по вхождению в группы, которые могут запускать usertask-и внутри процесса, или по вхождению в группу, которая может стартовать процесс

Пример:

https://test.region.igov.org.ua/wf/service/rest/getLoginBPs?sLogin=kermit

Пример результата

[{"sID":"dnepr_spravka_o_doxodax","sName":"Дніпропетровськ - Отримання довідки про доходи фіз. осіб"},{"sID":"dnepr_subsidies2","sName":"Отримання субсидії на оплату житлово-комунальних послуг2"},{"sID":"khmelnitskij_mvk_2","sName":"Хмельницький - Надання інформації, що підтверджує відсутність (наявність) земельної ділянки"},{"sID":"khmelnitskij_zemlya","sName":"Заява про наявність земельної ділянки"},{"sID":"kiev_spravka_o_doxodax","sName":"Київ - Отримання довідки про доходи фіз. осіб"},{"sID":"kuznetsovsk_mvk_5","sName":"Кузнецовськ МВК - Узгодження графіка роботи підприємства торгівлі\/обслуговування"},{"sID":"post_spravka_o_doxodax_pens","sName":"Отримання довідки про доходи (пенсійний фонд)"}]

#### 24. Получение расписаний включений ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/getSheduleFlowIncludes?nID_Flow_ServiceData=[flowId]

flowId - ID потока

Пример:

https://test.region.igov.org.ua/wf/service/flow/getSheduleFlowIncludes?nID_Flow_ServiceData=1

Пример результата

[{"sData":null,"bExclude":false,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}},{"sData":null,"bExclude":false,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"10:30\"","sDateTimeTo":"\"12:30\"","nID":20364,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}]

#### 25. Добавление/изменение расписания включений ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/setSheduleFlowInclude?nID_Flow_ServiceData=[nID_Flow_ServiceData]&sName=[sName]&sRegionTime=[sRegionTime]&sDateTimeAt=[sDateTimeAt]&sDateTimeTo=[sDateTimeTo]&saRegionWeekDay=[saRegionWeekDay]

nID - ИД-номер //опциональный ,если задан - редактирование
nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
sName - Строка-название ("Вечерний прием")
sRegionTime - Строка период времени ("14:16-16-30")
saRegionWeekDay - Массив дней недели ("su,mo,tu")
sDateTimeAt - Строка-дата начала(на) в формате YYYY-MM-DD hh:mm:ss ("2015-07-31 19:00:00")
sDateTimeTo - Строка-дата конца(к) в формате YYYY-MM-DD hh:mm:ss ("2015-07-31 23:00:00")
sData - Строка с данными(выражением), описывающими формулу расписания (например: {"0 0/30 9-12 ? * TUE-FRI":"PT30M"})
nLen - Число, определяющее длительность слота
sLenType - Строка определяющее тип длительности слота

Пример:

https://test.region.igov.org.ua/wf/service/flow/setSheduleFlowInclude?nID_Flow_ServiceData=1&sName=Test&sRegionTime=%2210:30-11:30%22&sDateTimeAt=%222010-08-01%2010:10:30%22&sDateTimeTo=%222010-08-01%2018:10:00%22&saRegionWeekDay=%22mo,tu%22

Пример результата

{"sData":null,"bExclude":false,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}

#### 26. Удаление расписания включений ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/removeSheduleFlowInclude?nID_Flow_ServiceData=[nID_Flow_ServiceData]&nID=[nID]

nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
nID - ИД-номер Ответ: Массив объектов сущности расписаний включений

Пример:

https://test.region.igov.org.ua/wf/service/flow/removeSheduleFlowInclude?nID_Flow_ServiceData=1&nID=20367

Пример результата

{"sData":null,"bExclude":false,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}

#### 27. Получение расписаний исключений ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/getSheduleFlowExcludes?nID_Flow_ServiceData=[flowId]*

flowId - ID потока

Пример:

https://test.region.igov.org.ua/wf/service/flow/getSheduleFlowExcludes?nID_Flow_ServiceData=1

Пример результата

[{"sData":null,"bExclude":true,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}},{"sData":null,"bExclude":false,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"10:30\"","sDateTimeTo":"\"12:30\"","nID":20364,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}]

#### 28. Добавление/изменение расписания исключения ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/setSheduleFlowExclude?nID_Flow_ServiceData=[nID_Flow_ServiceData]&sName=[sName]&sRegionTime=[sRegionTime]&sDateTimeAt=[sDateTimeAt]&sDateTimeTo=[sDateTimeTo]&saRegionWeekDay=[saRegionWeekDay]

nID - ИД-номер //опциональный ,если задан - редактирование
nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
sName - Строка-название ("Вечерний прием")
sRegionTime - Строка период времени ("14:16-16-30")
saRegionWeekDay - Массив дней недели ("su,mo,tu")
sDateTimeAt - Строка-дата начала(на) в формате YYYY-MM-DD hh:mm:ss ("2015-07-31 19:00:00")
sDateTimeTo - Строка-дата конца(к) в формате YYYY-MM-DD hh:mm:ss ("2015-07-31 23:00:00")
sData - Строка с данными(выражением), описывающими формулу расписания (например: {"0 0/30 9-12 ? * TUE-FRI":"PT30M"})
nLen - Число, определяющее длительность слота
sLenType - Строка определяющее тип длительности слота

Пример:

https://test.region.igov.org.ua/wf/service/flow/setSheduleFlowExclude?nID_Flow_ServiceData=1&sName=Test&sRegionTime=%2210:30-11:30%22&sDateTimeAt=%222010-08-01%2010:10:30%22&sDateTimeTo=%222010-08-01%2018:10:00%22&saRegionWeekDay=%22mo,tu%22

Пример результата

{"sData":null,"bExclude":true,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}

#### 29. Удаление расписания исключений ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/removeSheduleFlowExclude?nID_Flow_ServiceData=[nID_Flow_ServiceData]&nID=[nID]

nID_Flow_ServiceData - номер-ИД потока (обязательный если нет sID_BP)
sID_BP - строка-ИД бизнес-процесса потока (обязательный если нет nID_Flow_ServiceData)
nID - ИД-номер Ответ: Массив объектов сущности расписаний исключений

Пример:

https://test.region.igov.org.ua/wf/service/flow/removeSheduleFlowExclude?nID_Flow_ServiceData=1&nID=20367

Пример результата

{"sData":null,"bExclude":true,"sName":"Test","sRegionTime":"\"10:30-11:30\"","saRegionWeekDay":"\"mo,tu\"","sDateTimeAt":"\"2010-08-01 10:10:30\"","sDateTimeTo":"\"2010-08-01 18:10:00\"","nID":20367,"nID_FlowPropertyClass":{"sPath":"org.wf.dp.dniprorada.base.service.flow.propertyHandler.DefaultFlowSlotScheduler","sBeanName":"defaultFlowSlotScheduler","nID":1,"sName":"DefaultFlowSlotScheduler"}}

#### 30. Работа с файлами-шаблонами ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/getPatternFile?sPathFile=[full-path-file]&sContentType=[content-type] --возвращает содержимое указанного файла с указанным типом контента (если он задан).

sPathFile - полный путь к файлу, например: folder/file.html.
sContentType - тип контента (опционально, по умолчанию обычный текст: text/plain)

Если указанный путь неверен и файл не найден -- вернется соответствующая ошибка.

Примеры:

https://test.region.igov.org.ua/wf/service/rest/getPatternFile?sPathFile=print//subsidy_zayava.html

ответ: вернется текст исходного кода файла-шаблона

https://test.region.igov.org.ua/wf/service/rest/getPatternFile?sPathFile=print//subsidy_zayava.html&sContentType=text/html

ответ: файл-шаблон будет отображаться в виде html-страницы

#### 31. Получение активных тикетов ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/flow/getFlowSlotTickets?sLogin=[sLogin]&bEmployeeUnassigned=[true|false]&sDate=[yyyy-MM-dd] -- возвращает активные тикеты, отсортированные по startDate

sLogin - имя пользоватеял для которого необходимо вернуть тикеты
bEmployeeUnassigned - опциональный параметр (false по умолчанию). Если true - возвращать тикеты не заассайненые на пользователей
sDate - опциональный параметр в формате yyyy-MM-dd. Дата за которую выбирать тикеты. При выборке проверяется startDate тикета (без учета времени. только дата). Если день такой же как и у указанное даты - такой тикет добавляется в результат.

Примеры:

https://test.region.igov.org.ua/wf/service/flow/getFlowSlotTickets?sLogin=kermit

[{"sDateStart":"2015-07-20T15:15:00","sDateEdit":"2015-07-06T11:03:52","sTaskDate":"2015-07-30T10:03:43","sDateFinish":"2015-07-20T15:30:00","nID_FlowSlot":"6","sNameBP":"Киев - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Надання послуги: Огляд авто","nID":"20005"},{"sDateStart":"2015-07-20T15:45:00","sDateEdit":"2015-07-06T23:25:15","sTaskDate":"2015-07-06T23:27:18","sDateFinish":"2015-07-20T16:00:00","nID_FlowSlot":"7","sNameBP":"Киев - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Надання послуги: Огляд авто","nID":"20010"}]

https://test.region.igov.org.ua/wf/service/flow/getFlowSlotTickets?sLogin=kermit&bEmployeeUnassigned=true

[{"sDateStart":"2015-08-03T08:00:00","sDateEdit":"2015-07-30T23:10:58","sTaskDate":"2015-07-30T23:50:07","sDateFinish":"2015-08-03T08:15:00","nID_FlowSlot":"20086","sNameBP":"Днепропетровск - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Друк держ.номерів","nID":"20151"},{"sDateStart":"2015-08-03T08:15:00","sDateEdit":"2015-07-31T21:00:56","sTaskDate":"2015-07-31T21:01:19","sDateFinish":"2015-08-03T08:30:00","nID_FlowSlot":"20023","sNameBP":"Киев - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Перевірка наявності обтяжень","nID":"20357"}]

https://test.region.igov.org.ua/wf/service/flow/getFlowSlotTickets?sLogin=kermit&bEmployeeUnassigned=true&sDate=2015-07-20

[{"sDateStart":"2015-07-20T15:15:00","sDateEdit":"2015-07-06T11:03:52","sTaskDate":"2015-07-30T10:03:43","sDateFinish":"2015-07-20T15:30:00","nID_FlowSlot":"6","sNameBP":"Киев - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Надання послуги: Огляд авто","nID":"20005"},{"sDateStart":"2015-07-20T15:45:00","sDateEdit":"2015-07-06T23:25:15","sTaskDate":"2015-07-06T23:27:18","sDateFinish":"2015-07-20T16:00:00","nID_FlowSlot":"7","sNameBP":"Киев - Реєстрація авто з пробігом в МРЕВ","nID_Subject":"20045","sUserTaskName":"Надання послуги: Огляд авто","nID":"20010"}]

#### 32. Получение списка ID пользовательских тасок по номеру заявки ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByOrder?nID_Protected=[nID_Protected] -- возвращает спискок ID пользовательских тасок по номеру заявки

nID_Protected - Номер заявки, в котором, все цифры кроме последней - ID процесса в activiti. А последняя цифра - его контрольная сумма зашифрованная по алгоритму Луна.

Примеры:

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByOrder?nID_Protected=123452

Responce status 403.

{"code":"BUSINESS_ERR","message":"CRC Error"}

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByOrder?nID_Protected=123451

Если процесса с ID 12345 и тасками нет в базе то:

Responce status 403.

{"code":"BUSINESS_ERR","message":"Record not found"}

Если процесс с ID 12345 есть в базе с таской ID которой 555, то:

Responce status 200.

[ 555 ]

#### 33. Получение количества записей HistoryEvent_Service для сервиса по регионам ↑Up

HTTP Metod: GET

HTTP Context: https://test.igov.org.ua/wf/service/services/getStatisticServiceCounts?nID_Service=[nID_Service]

nID_Service - ID сервиса.

Примеры:

https://test.igov.org.ua/wf/service/services/getStatisticServiceCounts?nID_Service=1

Результат

[{"nCount":1,"sName":"Івано-Франківська"},{"nCount":3,"sName":"Дніпропетровська"},{"nCount":1,"sName":"Львівська"}]

####34. Аплоад(upload) и прикрепление текстового файла в виде атачмента к таске Activiti ↑Up

HTTP Metod: POST

HTTP Context: http://server:port/wf/service/rest/file/upload_content_as_attachment - Аплоад(upload) и прикрепление текстового файла в виде атачмента к таске Activiti

nTaskId - ИД-номер таски
sContentType - MIME тип отправляемого файла (опциоанльно) (значение по умолчанию = "text/html")
sDescription - описание
sFileName - имя отправляемого файла

Пример: http://localhost:8080/wf-central/service/rest/file/upload_content_as_attachment?nTaskId=24&sDescription=someText&sFileName=FlyWithMe.html

Ответ без ошибок:

{"taskId":"38","processInstanceId":null,"userId":"kermit","name":"FlyWithMe.html","id":"25","type":"text/html;html","description":"someText","time":1433539278957,"url":null} 
ID созданного attachment - "id":"25"

Ответ с ошибкой:

{"code":"SYSTEM_ERR","message":"Cannot find task with id 384"}

#### 35. Электронная эскалация ↑Up

ФУНКЦИИ ЭСКАЛАЦИИ (EscalationRuleFunction)

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/setEscalationRuleFunction

добавление/обновление записи функции эскалации

параметры:

nID - ИД-номер (уникальный-автоитерируемый), опционально
sName - строка-название (Например "Отсылка уведомления на электронную почту"), обязательно
sBeanHandler - строка бина-обработчика, опционально

ответ: созданная/обновленная запись.

если nID не задан, то это создание записи
если nID задан, но его нету -- будет ошибка "403. Record not found"
если nID задан, и он есть -- запись обновляется

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/getEscalationRuleFunction

возврат одной записи функции эскалации по ее nID, если записи нету -- "403. Record not found"

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/getEscalationRuleFunctions

выборка всех записей функции эскалации

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/removeEscalationRuleFunction

удаление записи функции эскалации по ее nID, если записи нету -- "403. Record not found"

ПРАВИЛА ЭСКАЛАЦИИ (EscalationRule)

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/setEscalationRule

добавление/обновление записи правила эскалации

параметры:

nID - ИД-номер (уникальный-автоитерируемый)
sID_BP - ИД-строка бизнес-процесса
sID_UserTask - ИД-строка юзертаски бизнеспроцесса (если указана * -- то выбираются все задачи из бизнес-процесса)
sCondition - строка-условие (на языке javascript )
soData - строка-обьект, с данными (JSON-обьект)
sPatternFile - строка файла-шаблона (примеры тут)
nID_EscalationRuleFunction - ИД-номер функции эскалации

ответ: созданная/обновленная запись.

если nID не задан, то это создание записи
если nID задан, но его нету -- будет ошибка "403. Record not found"
если nID задан, и он есть -- запись обновляется

ПРИМЕР: test.region.igov.org.ua/wf/service/escalation/setEscalationRule?sID_BP=zaporoshye_mvk-1a&sID_UserTask=*&sCondition=nElapsedDays==nDaysLimit&soData={nDaysLimit:3,asRecipientMail:[test@email.com]}&sPatternFile=escalation/escalation_template.html&nID_EscalationRuleFunction=1

ОТВЕТ:

{
"sID_BP":"zaporoshye_mvk-1a",
"sID_UserTask":"*",
"sCondition":"nElapsedDays==nDaysLimit",
"soData":"{nDaysLimit:3,asRecipientMail:[test@email.com]}",
"sPatternFile":"escalation/escalation_template.html",
"nID":1008,
"nID_EscalationRuleFunction":
{"sBeanHandler":"EscalationHandler_SendMailAlert",
"nID":1,
"sName":"Send Email"}
}

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/getEscalationRule

возврат одной записи правила эскалации по ее nID, если записи нету -- "403. Record not found"

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/removeEscalationRule

удаление записи правила эскалации по ее nID, если записи нету -- "403. Record not found"

HTTP Metod: GET

HTTP Context: test.region.igov.org.ua/wf/service/escalation/getEscalationRules

возвращает список всех записей правил ескалации

####36. Поиск заявок по тексту (в значениях полей без учета регистра) ↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByText?sFind=[sFind]&sLogin=[sLogin]&bAssigned=true -- возвращает список ID тасок у которых в полях встречается указанный текст

sFind - текст для поиска в полях заявки.
sLogin - необязательный параметр. При указании выбираются только таски, которые могут быть заассайнены или заассайнены на пользователя sLogin
bAssigned - необязательный параметр. Указывает, что нужно искать по незаассайненным таскам (bAssigned=false) и по заассайненным таскам(bAssigned=true) на пользователя sLogin

Примеры:

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByText?sFind=будинк

["4637994","4715238","4585497","4585243","4730773","4637746"]

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByText?sFind=будинк&sLogin=kermit

["4637994","4715238","4585243","4730773","4637746"]

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByText?sFind=будинк&sLogin=kermit&bAssigned=false

["4637994","4637746"]

https://test.region.igov.org.ua/wf/service/rest/tasks/getTasksByText?sFind=будинк&sLogin=kermit&bAssigned=true

["4715238","4585243","4730773"]

####37. Получения ключа для аутентификации ↑Up

HTTP Metod: GET

HTTP Context: http://server:port/wf/service/services/getAccessKey? -- возвращает ключ для аутентификации

sAccessContract - контракт
sAccessLogin - технический логин
sData - контент по которому генерируется ключ

Пример https://test.igov.org.ua/wf/service/services/getAccessKey?sAccessLogin=activiti-master&sAccessContract=Request&sData=/wf/service/setMessage

####38. Вызов сервиса уточнения полей формы ↑Up

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/setTaskQuestions?nID_Protected=[nID_Protected]&saField=[saField]&sMail=[sMail] сервис запроса полей, требующих уточнения у гражданина, с отсылкой уведомления параметры:

nID_Protected - номер-ИД заявки (защищенный)
saField - строка-массива полей (пример: "[{'id':'sFamily','type':'string','value':'Иванов'},{'id':'nAge','type':'long'}]")
sMail - строка электронного адреса гражданина
sHead - строка заголовка письма (опциональный, если не задан, то "Необхідно уточнити дані")
sBody - строка тела письма (опциональный, добавляется перед таблицей, сли не задан, то пустота)

при вызове сервиса:

обновляется запись HistoryEvent_Service полем значениями из soData (из saField), sToken (сгенерированый случайно 20-ти символьный код), sHead, sBody (т.е. на этоп этапе могут быть ошибки, связанные с нахождением и апдейтом обьекта события по услуге)
отсылается письмо гражданину на указанный емейл (sMail):

с заголовком sHead,
телом sBody
перечисление полей из saField в формате таблицы: Поле / Тип / Текущее значение
гиперссылкой в конце типа: https://[hostCentral]/order?nID_Protected=[nID_Protected]&sToken=[sToken]

находитcя на региональном портале таска, которой устанавливается в глобальную переменные sQuestion содержимое sBody и saFieldQuestion - содержимое saField
сохраняется информация о действии в Моем Журнале в виде

"По заявці №____ задане прохання уточнення: [sBody]"
плюс перечисление полей из saField в формате таблицы Поле / Тип / Текущее значение

Пример: https://test.region.igov.org.ua/wf/service/rest/setTaskQuestions?nID_Protected=52302969&saField=[{'id':'bankIdfirstName','type':'string','value':'3119325858'}]&sMail=test@email

Ответы: Пустой ответ в случае успешного обновления (и приход на указанный емейл письма описанного выше формата)

Возможные ошибки:

не найдена заявка (Record not found) или ид заявки неверное (CRC Error)
связанные с отсылкой письма, например, невалидный емейл (Error happened when sending email)
из-за некорректных входящих данных, например неверный формат saField (пример ошибки: Expected a ',' or ']' at 72 [character 73 line 1])

####39. Вызов сервиса ответа по полям требующим уточнения
↑Up

HTTP Context: https://test.region.igov.org.ua/wf/service/rest/setTaskAnswer?nID_Protected=[nID_Protected]&saField=[saField]&sToken=[sToken]&sBody=[sBody]

-- обновляет поля формы указанного процесса значениями, переданными в параметре saField Важно:позволяет обновлять только те поля, для которых в форме бизнес процесса не стоит атрибут writable="false"

nID_Protected - номер-ИД заявки (защищенный)
saField - строка-массива полей (например: "[{'id':'sFamily','type':'string','value':'Белявцев'},{'id':'nAge','type':'long','value':35}]")
sToken - строка-токена. Данный параметр формируется и сохраняется в запись HistoryEvent_Service во время вызова метода setTaskQuestions
sBody - строка тела сообщения (опциональный параметр)

Во время выполнения метод выполняет такие действия

Находит в сущности HistoryEvent_Service нужную запись (по nID_Protected) и сверяет токен. Eсли токен в сущности указан но не совпадает с переданным, возвращается ошибка "Token wrong". Если он в сущности не указан (null) - возвращается ошибка "Token absent".
Находит на региональном портале таску и устанавливает в глобальную переменную sAnswer найденной таски содержимое sBody.
Устанавливает в каждое из полей из saField новые значения
Обновляет в сущности HistoryEvent_Service поле soData значением из saField и поле sToken значением null.
Сохраняет информацию о действии в Мой Журнал (Текст: На заявку №____ дан ответ гражданином: [sBody])

Примеры:

https://test.region.igov.org.ua/wf/service/rest/setTaskAnswer?nID_Protected=54352839&saField=[{%27id%27:%27bankIdinn%27,%27type%27:%27string%27,%27value%27:%271234567890%27}]&sToken=93ODp4uPBb5To4Nn3kY1

Ответы: Пустой ответ в случае успешного обновления

Токен отсутствует

{"code":"BUSINESS_ERR","message":"Token is absent"}

Токен не совпадает со значением в HistoryEvent_Service

{"code":"BUSINESS_ERR","message":"Token is absent"}

Попытка обновить поле с атрибутом writable="false"

{"code":"BUSINESS_ERR","message":"form property 'bankIdinn' is not writable"}

####40. Получеение и установка прав доступа к rest сервисам
↑Up

HTTP Metod: GET

HTTP Context: https://test.region.igov.org.ua/wf/service/access/hasAccessServiceLoginRight?sLogin=[sLogin]&sService=[sService]&sData=[sData] -- возвращает true - если у пользоватля с логином sLogin есть доступ к рест сервиу sService при вызове его с аргументами sData, или false - если доступа нет.

sLogin - имя пользователя для которого проверяется доступ
sService - строка сервиса
sData - опциональный параметр со строкой параметров к сервису (формат передачи пока не определен). Если задан бин sHandlerBean (см. ниже) то он может взять на себя проверку допуспности сервиса для данного набора параметров.

Примеры:

https://test.region.igov.org.ua/wf/service/access/hasAccessServiceLoginRight?sLogin=SomeLogin&sService=access/hasAccessServiceLoginRight

Ответ:

false

HTTP Context: https://test.region.igov.org.ua/wf/service/access/getAccessServiceLoginRight?sLogin=[sLogin] -- возвращает список всех сервисов доступных пользователю с именем sLogin с формате JSON.

sLogin - имя пользователя

Примеры:

https://test.region.igov.org.ua/wf/service/access/getAccessServiceLoginRight?sLogin=TestLogin

Ответ:

[
    "TestService"
]

HTTP Metod: POST

HTTP Context: https://test.region.igov.org.ua/wf/service/access/setAccessServiceLoginRight -- Сохраняет запись в базе, что пользователь sLogin имеет доступ к сервису sService. Существование такого пользователя и сервиса не проверяется.

Параметры:

sLogin - имя пользователя
sService - строка сервиса
sHandlerBean - опцинальный параметр: имя спрингового бина реализующего интерфейс AccessServiceLoginRightHandler, который будет заниматься проверкой прав доступа для данной записи. При сохранении проверяется наличие такого бина, и если его нет - то будет выброшена ошибка.

Примеры:

https://test.region.igov.org.ua/wf/service/access/setAccessServiceLoginRight

sLogin=SomeLogin
sService=access/hasAccessServiceLoginRight

Ответ: Status 200

https://test.region.igov.org.ua/wf/service/access/setAccessServiceLoginRight?

sLogin=SomeLogin
sService=access/hasAccessServiceLoginRight
sHandlerBean=WrongBean

Ответ:

{
    "code": "SYSTEM_ERR",
    "message": "No bean named 'WrongBean' is defined"
}

HTTP Metod: DELETE

HTTP Context: https://test.region.igov.org.ua/wf/service/access/removeAccessServiceLoginRight?sLogin=[sLogin]&sService=[sService] -- Удаляет запись из базы, что пользователь sLogin имеет доступ к сервису sService. Статус код 200 означает что запись успешно удалена. Код 304 - что такая запись не найдена.

Параметры:

sLogin - имя пользователя
sService - строка сервиса

Примеры:

https://test.region.igov.org.ua/wf/service/access/removeAccessServiceLoginRight?sLogin=TestLogin&sService=TestService

Ответ: Status 200

https://test.region.igov.org.ua/wf/service/access/removeAccessServiceLoginRight?sLogin=FakeLogin&sService=TestService

Ответ: Status 304

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

specification.md

specification.md

iGov.ua APIs

iGov.ua APIs

Mandatory HTTP Headers

1. Аутентификация пользователя

Логин пользователя:

Логаут пользователя (наличие cookie JSESSIONID):

2. Activiti

Запуск процесса Activiti:

Загрузка задач из Activiti:

Загрузка каталога сервисов из Activiti:

Response КОНТЕНТ ДОКУМЕНТА В ВИДЕ СТРОКИ

Files

specification.md

Latest commit

History

specification.md

File metadata and controls

iGov.ua APIs

iGov.ua APIs

Mandatory HTTP Headers

1. Аутентификация пользователя

Логин пользователя:

Логаут пользователя (наличие cookie JSESSIONID):

2. Activiti

Запуск процесса Activiti:

Загрузка задач из Activiti:

Загрузка каталога сервисов из Activiti:

Response КОНТЕНТ ДОКУМЕНТА В ВИДЕ СТРОКИ