Веб-сервис essencemanager

Веб-Сервис EssenceManager предназначен для приема, передачи данных от внешних источников.

Данный Веб-Сервис находится в разработке, и текущая документация будет обновляться и дополняться конкретикой в процессе его разработки.

Технические данные:

Тип веб-сервиса (web-service type): JAX-WS 2.1

Расположение на площадке АСГЕ (Location) [1]: Отсутствует

Расположение на площадке Водоканала(Location): http://192.168.58.199:7001/asge-portal/webservices/EssenceManagerService

WSDL на площадке АСГЕ: Отсутствует

WSDL на площадке водоканала: http://192.168.58.199:7001/asge-portal/webservices/EssenceManagerService?wsdl

Методы Веб-Сервиса.

Данный Веб-Сервис содержит четыре метода. Общее описание методов представлено в Таблица 1 Методы Веб-Сервиса EssenceManager.

Таблица 1 Методы Веб-Сервиса EssenceManager

Название метода	Описание
essenceGetter	Возвращает список сущностей по заданным параметрам. Параметры: String essenceCode – код сущности для получения, например, ExdDevices – получения НСИ [2]по приборам; BigDecimal essenceOuid – идентификатор сущности, если не задан возвращается список; String dbCode – в какой базе искать сущность. См. Список сущностей в системе; AsgeWSEssenceCriteria[] criteriaList – список критериев поиска; Integer fromEssenceNumber – с какой по счету записи возвращать список. AsgeWSEssenceCriteria[] orderByList – список атрибутов для сортировки; Возвращаемое значение: AsgeWSResult.
essenceCreator	Создает сущность с заданными параметрами Параметры: AsgeWSEssence essence –сущность для создания Возвращаемое значение: AsgeWSResult.
essenceUpdater	Обновляет сущность с заданными параметрами Параметры: AsgeWSEssence essence –сущность для обновления Возвращаемое значение: AsgeWSResult.
essenceDeleter	Удаляет сущность с заданным идентификатором ЕХД Параметры: String essenceCode – код сущности для получения, например, Devices – получения НСИ по приборам BigDecimal ouid – идентификатор сущности для удаления Возвращаемое значение: AsgeWSResult.

1) Метод EssenceGetter

По умолчанию сортировка осуществляется по атрибуту «Идентификатор»-«ouid».

Таблица 2 Входящие параметры метода EssenceManager.essenceGetter

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
essenceCode	String – строка	Да
essenceOuid	BigDecimal - число	Нет
dbCode	String – строка	Да Может принимать значения: См. Список сущностей в системе.
criteriaList	AsgeWSEssenceCriteria[] – список атрибутов	Cписок критериев поиска
fromEssenceNumber	Integer - число	с какой по счету записи возвращать список
orderByList	AsgeWSEssenceCriteria[] – список атрибутов	Cписок атрибутов для сортировки

Таблица 3 Возвращаемые значения метода EssenceManager. essenceGetter

Что возвращается	В каком случае возвращается	Значение полей AsgeWSResult
status	message	detailedMessage	errorCode	essenceOuid	essenceList
AsgeWSResult	Запрос обработан удачно, и запрашиваемые данные найдены в ЕХД[3].	OK	null	null	null	null	AsgeWSEssence[]
AsgeWSResult	Запрос обработан удачно, и запрашиваемые данные не найдены в ЕХД	NODATA	No data found for setted criteria.	null	null	null	null
AsgeWSResult	Возвращается в том случае, когда на стороне ЕХД произошла ошибка при обработке данных в ЕХД.	FAILED	Описание ошибки	Значение stack trace	Код ошибки в ЕХД	null	null

2) Метод EssenceCreator

Таблица 4 Входящие параметры метода EssenceManager.essenceCreator

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
essence	AsgeWSEssence–AsgeWSEssence	Да
dbCode	String – строка	Да См. Список сущностей в системе.

Таблица 5 Возвращаемые значения метода EssenceManager. essenceCreator

Что возвращается	В каком случае возвращается	Значение полей AsgeWSResult
status	message	detailedMessage	errorCode	essenceOuid	essenceList
AsgeWSResult	Запрос обработан удачно, и запрашиваемая сущность создана в ЕХД.	OK	null	null	null	Идентификатор созданной сущности	null
AsgeWSResult	Возвращается в том случае, когда на стороне ЕХД произошла ошибка при обработке данных в ЕХД.	FAILED	Описание ошибки	Значение stack trace	Код ошибки в ЕХД	null	null

3) Метод EssenceUpdater

Таблица 6 Входящие параметры метода EssenceManager.essenceUpdater

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
essence	AsgeWSEssence – AsgeWSEssence	Да
dbCode	String	Да См. Список сущностей в системе.

Таблица 7 Возвращаемые значения метода EssenceManager. essenceUpdater

Что возвращается	В каком случае возвращается	Значение полей AsgeWSResult
status	message	detailedMessage	errorCode	essenceOuid	essenceList
AsgeWSResult	Запрос обработан удачно, и запрашиваемая сущность обновлена в ЕХД.	OK	null	null	null	null	null
AsgeWSResult	Возвращается в том случае, когда на стороне ЕХД произошла ошибка при обработке данных в ЕХД.	FAILED	Описание ошибки	Значение stack trace	Код ошибки в ЕХД	null	null

4) Метод EssenceDeleter

Таблица 8 Входящие параметры метода EssenceManager.essenceDeleter

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
EssenceCode	String – строка	Да
Ouid	BigDecimal - число	Да

Таблица 9 Возвращаемые значения метода EssenceManager. essenceDeleter

Что возвращается	В каком случае возвращается
DELETED	Запрос обработан удачно, и заданная сущность удалена из ЕХД.
FAILED: [описание ошибки]	Возвращается в том случае, когда на стороне КСДУ произошла ошибка при обработке данных в ЕХД.

Дата добавления: 2015-07-02