Веб-Сервис KSDUWebServicesManager

Веб-Сервис KSDUWebServicesManager предназначен для передачи обработанных данных специфических данных, которые находятся на хранении в ЕХД.

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

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

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

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

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

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

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

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

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

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

Название метода	Описание
getDataExtended	Возвращает список значений по заданным фильтрам. Либо последнее значение на указанную дату или интерполированное значение (если интерполяция возможна). Параметры: DataFilter[] filters – список фильтров; Возвращаемое значение: AsgeWSResult[].
getHValuesSum	Возвращает сумму часовых значений плейс-кода за определенный период времени. Параметры: BigDecimal placeCode - Плейс-Код; Date dateFrom – дата начала периода для суммирования; Date dateTo – дата окончания периода для суммирования; Возвращаемое значение: AsgeWSResult.
getSumByNode	Возвращает сумму часовых значений для всех плейс-кодов, которые привязаны к указанному Ноду.. Параметры: BigDecimal nodeCode – Код нода; Date dateFrom – дата начала периода для суммирования; Date dateTo – дата окончания периода для суммирования; Возвращаемое значение: AsgeWSResult.

1) Метод getDataExtended

Таблица 11 Входящие параметры метода KSDUWebServicesManager.getDataExtended

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
filters	DataFilter[] – список фильтров	Да

Таблица 12 Возвращаемые значения метода KSDUWebServicesManager.getDataExtended

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

В возвращаемых AsgeWSEssence будут атрибуты со следующими кодами:

· places – место учета;

· value – значение +;

· nvalue – значение – (где применимо);

· valueTime – реальная дата значения.

2) Метод getHValuesSum

Таблица 13 Входящие параметры метода KSDUWebServicesManager. getHValuesSum

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
placeCode	BigDecimal - число	Да
dateFrom	Date – дата и время	Да
dateTo	Date – дата и время	Да

Таблица 14 Возвращаемые значения метода KSDUWebServicesManager. getHValuesSum

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

В возвращаемой AsgeWSEssence будут атрибуты со следующими кодами:

· places – место учета;

· value – значение +;

· quality – качество показания.

3) Метод getSumByNode

Таблица 15 Входящие параметры метода KSDUWebServicesManager. getSumByNode

Имя параметра в спецификации веб-сервиса	Тип параметра	Является обязательным
nodeCode	BigDecimal - число	Да
dateFrom	Date – дата и время	Да
dateTo	Date – дата и время	Да

Таблица 16 Возвращаемые значения метода KSDUWebServicesManager. getSumByNode

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

В возвращаемой AsgeWSEssence будут атрибуты со следующими кодами:

· node – место учета;

· value – значение +;

· quality – качество показания.

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