Описание формата электронного сервиса СМЭВ и руководство пользователя электронного сервиса СМЭВ (стр. 2 )

В случае ошибки, электронный сервис вернет код ошибки с описанием причины её возникновения.

2.5 Схема взаимодействия

В рамках взаимодействия информационная система потребителя направляет в адрес электронного сервиса один из двух вариантов сообщений (запрос):

1.  учетные данные пользователя, регистрационный номер классификатора, часть кода объекта классификации или код целиком, значения диапазона запрашиваемых значений и параметры сортировки результатов ответа.

2.  учетные данные пользователя, регистрационный номер классификатора, часть полного наименования объекта классификации или полное наименование целиком, значения диапазона запрашиваемых значений и параметры сортировки результатов ответа.

После получения и обработки запроса электронный сервис должен вернуть один из двух вариантов сообщений (ответ):

1.  перечень записей, содержащих идентификаторы, коды и полные наименования объектов классификации.

2.  код и описание ошибки в случае, если в запросе содержаться некорректные данные (например, неверное имя пользователя или пароль).

Схема взаимодействия представлена на рисунке 1.

Информационная система потребителя

Рисунок 1 «Схема взаимодействия»

2.6 Связи с другими электронными сервисами

Данный сервис не имеет связей с другими сервисами.

3  Руководство пользователя

3.1 Операция «Все идентификаторы записи об объекте классификации по коду объекта»

3.1.1 Общие сведения

Код операции:	getRecordIDsByObjectID
Наименование операции:	Все идентификаторы записи об объекте классификации по коду объекта
Назначение операции:	Получение всех идентификаторов записей об объекте классификации по коду объекта

3.1.2 Описание входных параметров

Входные данные: getRecordIDsByObjectID

№	Код параметра	Описание параметра	Обязательность	Способ заполнения/Тип	Комментарий
1	login	Имя пользователя	+	xs:string
2	pass	Пароль пользователя	+	xs:string	MD5 хэш пароля
3	RegNumber	Регистрационный номер классификатора	+	xs:int
4	Code	Часть кода объекта классификации	+	xs:string
5	startPosition	Начальная позиция диапазона запрашиваемых значений		xs:int	Значение по умолчанию - "1".
6	diapason	Количество запрашиваемых записей		xs:int	Значение по умолчанию - "200".
7	SortColumn	Поле сортировки результата ответа		xs:string	Допустимо: Null, id, code, fullname. Значение по умолчанию - "id" (идентификатор записи).
8	SortOrder	Порядок сортировки		xs:string	Допустимо: Null, asc, desc. Значение по умолчанию - "asc" (по возрастанию).

3.1.3 Описание выходных параметров

Выходные данные: getRecordIDsByObjectIDResponse

№	Код параметра	Описание параметра	Обязательность	Способ заполнения/Тип	Комментарий
1	ID	ID записи		xs:int
2	Code	Код объекта классификации		xs:string
3	Fullname	Полное наименование объекта классификации		xs:string

Параметры комплексного типа описаны в приложении «Описание общих структур данных».

3.1.4 Коды возвратов

№	Код возврата	Описание кода возврата	Условия возникновения	Комментарий
1	0	Нет ошибок	Данный код возврата соответствует ситуации, когда электронный сервис отработал без ошибок и вернул не пустой список классификаторов.
2	1	По вашему запросу ничего не найдено	Данный код возврата соответствует ситуации, когда электронный сервис отработал без ошибок, но не найдено данных на основе входящих параметров.
3	-1	Ошибка аутентификации (неверный логин/пароль)	Данный код возврата соответствует ситуации, когда были введены неверные учетные данные пользователя.
4	-2	Некорректное значение начальной позиции	Данный код возврата соответствует ситуации, когда было введено некорректное значение начальной позиции.
5	-3	Некорректное значение диапазона	Данный код возврата соответствует ситуации, когда было введено некорректное значение количества запрашиваемых записей.
6	-4	Неверный регистрационный номер классификатора	Данный код возврата соответствует ситуации, когда в системе отсутствуют опубликованные классификаторы с указанным регистрационным номером
7	-8	Системная ошибка	Данный код возврата соответствует ситуации, когда во время работы электронного сервиса возникла ошибка, не связанная с действиями пользователя.	Ошибка возникает в случае отсутствия сети, недоступности базы данных и т. д.
8	-9	Неверно заданы параметры сортировки результата	Данный код возврата соответствует ситуации, когда были введены неверные параметры сортировки результата ответа

3.1.5 Контрольные примеры

Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:obj="http://ws. iac. spb. ru/ObjectIDs"> <soapenv:Header/> <soapenv:Body> <obj:getRecordIDsByObjectID> <login>имя пользователя</login> <pass>пароль</pass> <RegNumber>2</RegNumber> <Code>66</Code> <startPosition>1</startPosition> <diapason>2</diapason> <sortColumn>ID</sortColumn> <sortOrder>ASC</sortOrder> </obj:getRecordIDsByObjectID> </soapenv:Body> </soapenv:Envelope>

Ответ на запрос в случае успешного исполнения (код возврата 0)

<S:Envelope xmlns:S="http://schemas. xmlsoap. org/soap/envelope/"> <S:Body> <ns2:getRecordIDsByObjectIDResponse xmlns:ns2="http://ws. iac. spb. ru/ObjectIDs"> <return> <MessageInfo> <FaultCode>0</FaultCode> <FaultMessage>Операция успешно завершена</FaultMessage> <StartPosition>1</StartPosition> <Diapason>2</Diapason> <ItemsInMessage>2</ItemsInMessage> <ItemsInResponse>9468</ItemsInResponse> <ItemStructure>ID, Code, FullName</ItemStructure> </MessageInfo> <Item> <ID>92</ID> <Code>01206866000</Code> <Fullname>Партизанский</Fullname> </Item> <Item> <ID>127</ID> <Code>01209866000</Code> <Fullname>Титовский</Fullname> </Item> </return> </ns2:getRecordIDsByObjectIDResponse> </S:Body> </S:Envelope>

Запрос на получение ответа с кодом возврата 1

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:obj="http://ws. iac. spb. ru/ObjectIDs"> <soapenv:Header/> <soapenv:Body> <obj:getRecordIDsByObjectID> <login>имя пользователя</login> <pass>пароль</pass> <RegNumber>302</RegNumber> <Code>66</Code> <startPosition>1</startPosition> <diapason>2</diapason> <sortColumn>ID</sortColumn> <sortOrder>ASC</sortOrder> </obj:getRecordIDsByObjectID> </soapenv:Body> </soapenv:Envelope>

Ответ на запрос с кодом возврата 1