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

№

Код параметра

Описание параметра

Обязательность

Способ заполнения/Тип

Комментарий

1

login

Имя пользователя

+

xs:string

2

pass

Пароль пользователя

+

xs:string

MD5 хэш пароля

3

RegNumber

Регистрационный номер классификатора

+

xs:int

4

Fullname

Часть полного наименования объекта классификации

+

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.2.3 Описание выходных параметров

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

№

Код параметра

Описание параметра

Обязательность

Способ заполнения/Тип

Комментарий

1

ID

ID записи

xs:int

2

Code

Код объекта классификации

xs:string

3

Fullname

Полное наименование объекта классификации

xs:string

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

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

№

Код возврата

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

Условия возникновения

Комментарий

1

0

Нет ошибок

Данный код возврата соответствует ситуации, когда электронный сервис отработал без ошибок и вернул не пустой список классификаторов.

2

1

По вашему запросу ничего не найдено

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

3

-1

Ошибка аутентификации (неверный логин/пароль)

Данный код возврата соответствует ситуации, когда были введены неверные учетные данные пользователя.

4

-2

Некорректное значение начальной позиции

Данный код возврата соответствует ситуации, когда было введено некорректное значение начальной позиции.

5

-3

Некорректное значение диапазона

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

6

-4

Неверный регистрационный номер классификатора

Данный код возврата соответствует ситуации, когда в системе отсутствуют опубликованные классификаторы с указанным регистрационным номером

7

-8

Системная ошибка

Данный код возврата соответствует ситуации, когда во время работы электронного сервиса возникла ошибка, не связанная с действиями пользователя.

Ошибка возникает в случае отсутствия сети, недоступности базы данных и т. д.

8

-9

Неверно заданы параметры сортировки результата

Данный код возврата соответствует ситуации, когда были введены неверные параметры сортировки результата ответа

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

НЕ нашли? Не то? Что вы ищете?

Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:obj="http://ws. iac. spb. ru/ObjectIDs">

<soapenv:Header/>

<soapenv:Body>

<obj:getRecordIDsByObjectFullname>

<login>имя пользователя</login>

<pass>пароль</pass>

<RegNumber>2</RegNumber>

<Fullname>г</Fullname>

<startPosition>1</startPosition>

<diapason>2</diapason>

<sortColumn>ID</sortColumn>

<sortOrder>ASC</sortOrder>

</obj:getRecordIDsByObjectFullname>

</soapenv:Body>

</soapenv:Envelope>

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

<S:Envelope xmlns:S="http://schemas. xmlsoap. org/soap/envelope/">

<S:Body>

<ns2:getRecordIDsByObjectFullnameResponse 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>75776</ItemsInResponse>

<ItemStructure>ID, Code, FullName</ItemStructure>

</MessageInfo>

<Item>

<ID>2</ID>

<Code>01200000000</Code>

<Fullname>Районы Алтайского края/</Fullname>

</Item>

<Item>

<ID>4</ID>

<Code>01201800000</Code>

<Fullname>Сельсоветы Алейского р-на/</Fullname>

</Item>

</return>

</ns2:getRecordIDsByObjectFullnameResponse>

</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:getRecordIDsByObjectFullname>

<login>имя пользователя</login>

<pass>пароль</pass>

<RegNumber>302</RegNumber>

<Fullname>г</Fullname>

<startPosition>1</startPosition>

<diapason>2</diapason>

<sortColumn>ID</sortColumn>

<sortOrder>ASC</sortOrder>

</obj:getRecordIDsByObjectFullname>

</soapenv:Body>

</soapenv:Envelope>

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

<S:Envelope xmlns:S="http://schemas. xmlsoap. org/soap/envelope/">

<S:Body>

<ns2:getRecordIDsByObjectFullnameResponse xmlns:ns2="http://ws. iac. spb. ru/ObjectIDs">

<return>

<MessageInfo>

<FaultCode>1</FaultCode>

<FaultMessage>Данные только в Zip-файле</FaultMessage>

</MessageInfo>

</return>

</ns2:getRecordIDsByObjectFullnameResponse>

</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:getRecordIDsByObjectFullname>

<login></login>

<pass></pass>

<RegNumber>2</RegNumber>

<Fullname>г</Fullname>

<startPosition>1</startPosition>

<diapason>2</diapason>

<sortColumn>ID</sortColumn>

<sortOrder>ASC</sortOrder>

</obj:getRecordIDsByObjectFullname>

</soapenv:Body>

</soapenv:Envelope>

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

<S:Envelope xmlns:S="http://schemas. xmlsoap. org/soap/envelope/">

<S:Body>

<ns2:getRecordIDsByObjectFullnameResponse xmlns:ns2="http://ws. iac. spb. ru/ObjectIDs">

<return>

<MessageInfo>

<FaultCode>-1</FaultCode>

<FaultMessage>Ошибка аутентификации</FaultMessage>

</MessageInfo>

</return>

</ns2:getRecordIDsByObjectFullnameResponse>

</S:Body>

</S:Envelope>

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

Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 7