Описание сущностей

Утверждаю
Заместитель руководителя
Федерального агентства воздушного
транспорта
______________ С.И. Кондратьев
"___" ____________2011г.
Формат сервиса подтверждения
нахождения судна в собственности и
принадлежности
Российской Федерации
Москва 2011
Аннотация
В настоящем Документе описывается программный интерфейс взаимодействия для
получения подтверждения нахождения судна в собственности и принадлежности
Российской Федерации.
В ходе создания интерфейса разработаны форматы сущностей сервиса подтверждения
нахождения судна в собственности и принадлежности Российской Федерации, которые
вызываются внешними информационными системами.
Оглавление
Аннотация .................................................................................................................................................... 2
Общие положения ....................................................................................................................................... 4
Термины и обозначения ......................................................................................................................... 4
Наименование системы .......................................................................................................................... 4
Информация о версии форматов взаимодействия .............................................................................. 4
Описание сущностей ................................................................................................................................... 4
Описание параметров сущностей .......................................................................................................... 4
Сведения из выписки НССП .................................................................................................................... 5
Порядок взаимодействия сервиса НССП с внешними информационными системами ....................... 5
Порядок обработки запросов к веб-сервису ........................................................................................ 5
Содержание запросов к веб-сервису..................................................................................................... 5
Порядок формирования ответов веб-сервиса ...................................................................................... 6
Общие положения
Термины и обозначения
Термин (сокращение)
SOAP
W3C
WSDL
XML
XSD
Определение
Simple Object Access Protocol – простой протокол обмена
структурированными сообщениями
World Wide Web Consortium – Консорциум Всемирной паутины
Web Services Description Language– язык описания веб-сервисов
Extensible Markup Language - расширяемый язык разметки
XML Schema definition - язык описания структуры XMLдокумента. Спецификация XML Schema является рекомендацией
W3C
Веб-сервис
ИС
РФ
Частный
случай
сервиса
программная
система,
идентифицируемая URI и предназначенная для поддержки
интероперабельных межмашинных взаимодействий в сетевой
среде
Информационная система
Российская Федерация
СЭД
Система электронного документооборота
Наименование системы
Полное наименование системы: Сервис подтверждения
собственности и принадлежности Российской Федерации.
Сокращенное наименование системы: Сервис НССП.
нахождения
судна
в
Информация о версии форматов взаимодействия
Версия форматов – 1.01.
Описание сущностей
Сервис НССП оперирует следующими сущностями:
 выписка НССП.
Назначения сущностей и состав параметров сущностей приведены в подпунктах
настоящего пункта.
Описание параметров сущностей
Сущности сервиса НССП описаны в формате XSD как XML-типы. Каждый параметр
сущности является тегом XML-типа.
Параметры приводимых сущностей сведены в таблицу со следующими полями:
 Наименование. Наименование тега XML-типа.
 Кол-во тегов. Указывает на количество тегов формируемого XML. Формат поля:
<min>..<max>, где <min> - минимальное количество тегов, <max> - максимальное
количество тегов («n» указывает на неограниченное количество тегов). Если
значение в поле не указано, то присутствует 1 тег.
 Тип данных. Возможные значения:
 String. Строка произвольной длины.
 Date. Дата
 Decimal. Вещественное число.
 Boolean. Логический тип (Истина/Ложь).
 Контейнер. Указывает на присутствие вложенных тегов. Наименования тегов,
вложенных в контейнер, включаются в поле «Наименование» таблицы параметров
со смещением вправо.
 Другой тип. В поле «Комментарий» таблицы параметров присутствует ссылка на
соответствующий пункт, в котором описан тип.
 Комментарий. Объясняет назначение тега.
Сведения из выписки НССП
Данные сведений из выписки НССП типа tns: ReturnMsg приведены в Таблице
1.
Таблица 1. Тег ReturnMsg.
Наименование
Колво
тегов
Тип данных
xsd:string
RequestIP
RequestCount
xsd:int
Комментарий
IP-адрес клиента
Общее количество обращений к
сервису
Порядок взаимодействия сервиса НССП с внешними
информационными системами
Порядок обработки запросов к веб-сервису
Веб-сервис НССП принимает от внешних информационных систем запросы, в ходе
обработки которых формирует ответ и возвращает его во внешнюю систему.
Содержание запросов к веб-сервису
Описание сведений GetAccessoryInfo, передаваемых в запросе приведено в таблице 3.
Таблица 2. Тег Request
Наименование
ShipNumber
Колво
тегов
1
Тип данных
tns:string128
ServiceRecipientNameUL
1
tns:string128
ServiceRecipientNameFL
1
tns:string128
ServiceRecipientINN
1
tns:string128
Комментарий
Регистрационны (бортовой) номер
судна
Наименование судовладельца (для
юридического лица)
Фамилия,
Имя
Отчество
судовладельца (для физического
лица)
ИНН заявителя
Пример запроса на формирование информации:
<SOAP-ENV:Envelope SOAPENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:servicewsdl">
<SOAP-ENV:Body>
<tns:GetAccessoryInfo xmlns:tns="urn:servicewsdl">
<document xsi:type="tns:RequestAccessoryDoc">
<ShipNumber xmlns="" xsi:type="tns:string128">AU659</ShipNumber>
<ServiceRecipientNameUL xmlns="" xsi:type="tns:string128">OOO
"Буксир"</ServiceRecipientNameUL>
<ServiceRecipientINN xmlns=""
xsi:type="tns:string128">1234567890</ServiceRecipientINN>
</document>
</tns:GetAccessoryInfo>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Порядок формирования ответов веб-сервиса
По результатам обработки запроса к методу веб-сервиса, вне зависимости от результата
его обработки, необходимо формировать ответ веб-сервиса – техническую квитанцию и
возвращать его инициатору запроса. Формат технической квитанции return имеет
структуру, описанную в таблице 4.
Таблица 3. Тег return
Наименование
RequestIP
RequestCount
Кол-во
тегов
Тип данных
xsd:string
xsd:int
Комментарий
IP-адрес клиента
Общее количество обращений к
сервису
При успешной обработке запроса формируется ответ, содержащий структуру сущности
НССП, описанной в таблице 1.
Пример ответа на запрос на формирование информации при успешной обработке запроса:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:servicewsdl">
<SOAP-ENV:Body>
<ns1:GetAccessoryInfoResponse xmlns:ns1="urn:servicewsdl">
<return xsi:type="tns:ReturnMsg">
<RequestIP xsi:type="xsd:string">192.168.144.7</RequestIP>
<RequestCount xsi:type="xsd:int">2</RequestCount>
</return>
</ns1:GetAccessoryInfoResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Пример ответа на запрос на формирование информации при возникновении сбоя:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAPENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:servicewsdl">
<SOAP-ENV:Body>
<ns1:GetAccessoryInfoResponse xmlns:ns1="urn:servicewsdl">
<return xsi:type="tns:ReturnMsg">
<RequestIP xsi:type="xsd:string">Ошибка заполнения данных</RequestIP>
<RequestCount xsi:type="xsd:int">0</RequestCount>
</return>
</ns1:GetAccessoryInfoResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>