Альбом форматов аис фссп россии


Адаптер сайта ФССП России



бет61/62
Дата20.06.2016
өлшемі4.42 Mb.
#150093
түріРеферат
1   ...   54   55   56   57   58   59   60   61   62

4.3. Адаптер сайта ФССП России


Данный адаптер предназначен для приема заявлений в формате ПИЭВ от сайта ФССП России. Кроме того, сервис позволяет выполнять интерактивную работу с ранее поданными заявлениями, в том числе получение заявлений и ответов СПИ на заявления.

Все типы данных и элементов сервиса находятся в пространстве имен «http://www.red-soft.biz/schemas/fssp/site/fe/1.0»


4.3.1. Простые типы данных


В таблице 266 описаны простые типы данных, используемые сервисом сайта.

Таблица 266:Простые типы данных, используемые сервисом сайта

Описание

Наименование типа данных

Базовый тип данных XSD

Ограничения типа в XSD-схеме

Системный идентификатор документа

SystemIdType

xs:long




Идентификатор документа внешнего контрагента или внешний идентификатор документа

ExternalIdType

xs:string

minLength = 1

maxLength = 60



Тип объекта

ObjectType

xs:string

minLength = 1

maxLength = 31



Дата документа

DocDateType

xs:date

minInclusive = 1900-01-01

Номер документа

DocNumberType

xs:string

maxLength = 25

Индекс первой записи/общее количество документов

ItemIndexType

xs:long

minInclusive = 0

Количество документов в выборке

ItemCountType

xs:long

minInclusive = 1

maxExclusive = 1000



Код организации межведомственного обмена

OrganizationCodeType

xs:string

minLength = 1

maxLength = 10



Код подразделения организации межведомственного обмена

DepartmentCodeType

xs:string

minLength = 1

maxLength = 20



Код протокола

ProtocolCodeType

xs:string

minLength = 1

maxLength = 20



Статус документа

DocumentStatusType

xs:string

NEW — Документ перешло на статус «Новый».

REGISTERED — Документ зарегистрирован.

COMPLETED — Документ исполнен или отказан

REJECTED — Отказано в обработке

TRANSFERRED — Передано в другое структурное подразделение.


Статус проверки

VerificationStatusType

xs:string

SUCCESS Проверка пройдена.

FAIL Проверка не пройдена.



Объект проверки

VerificationObject

xs:string

ENTITY — сущность.

SIGNATURE подпись.

SIGNATURE_CERTIFICATE — сертификат.

TIMESTAMP_SIGNATURE — дата и время проверки подписи.

TIMESTAMP_SIGNATURE_CERTIFICATE — дата и время проверки сертифтиката

TIMESTAMP — дата и время проверки.


4.3.2. Составные типы данных


В данном разделе описаны служебные составные типы данных, используемые в служебных блоках веб-сервиса.

4.3.2.1. Адрес узла АИС ФССП России/адрес внешнего контрагента


Тип данных «Адрес узла АИС ФССП России/адрес внешнего контрагента» предназначен для указания получателя сообщений

Наименование типа данных в XSD-схеме: Address. Описание типа данных приведено в таблице 267.



Таблица 267:Тип данных «Адрес узла АИС ФССП России/адрес внешнего контрагента», Address

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Код организации

organization

OrganizationCodeType

А

О




Код подразделения

department

DepartmentCodeType

А

Н




Код соглашения

protocol

ProtocolCodeType

А

О

Значение должно быть установлено на «САЙТ».

4.3.2.2. Список документов


Тип данных «Список документов» предназначен для передачи списка документов клиенту веб-сервиса.

Наименование типа данных в XSD-схеме: DocumentListType. Описание типа данных приведено в таблице 268.



Таблица 268:Тип данных «Список документов», DocumentListType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Заголовок списка документов

Header

DocumentListHeaderType

С

О




Документы

Document

EnvelopeType

С

НМ



4.3.2.3. Заголовок списка документов


Тип данных «Заголовок списка документов» предназначен для передачи данных о списке документов, таких как индекс первого элемента, количество документов, общее количество документов.

Наименование типа данных в XSD-схеме: DocumentListHeaderType. Описание типа данных приведено в таблице 269.



Таблица 269:Тип данных «Заголовок списка документов», DocumentListHeaderType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Индекс первого возвращенного документа списка

First

ItemIndexType

П

О




Количество документов в выборке

Count

ItemCountType

П

О




Общее количество документов

TotalCount

ItemIndexType

П

О



4.3.2.4. Фильтр списка документов


Тип данных «Фильтр списка документов» предназначен для передачи веб-сервису параметров фильтрации списка документов

Наименование типа данных в XSD-схеме: DocumentFilterType. Описание типа данных приведено в таблице 270.

Таблица 270:Тип данных «Фильтр списка документов», DocumentFilterType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Фильтр по номеру документа

DocNumber

DocNumberType

П

Н




Фильтр по дате документа

DocDate

DocDateFilterType

С

Н




Страничный фильтр

Paging

PageFilterType

С

Н




Фильтр по идентификатору документа

ExternalKey

ExternalIdType

П

Н




Тип документа

type

ObjectType

А

О



4.3.2.5. Фильтр по дате документа


Тип данных «Фильтр по дате документа» предназначен для передачи параметров фильтрации списка документов по дате документа. Возможна работа как с диапазоном дат, так и с определенной датой

Наименование типа данных в XSD-схеме: DocDateFilterType. Описание типа данных приведено в таблице 271.



Таблица 271:Тип данных «Фильтр по дате документа», DocDateFilterType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Начальная дата выборки

DateFrom

DocDateType

П

Н

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

Конечная дата выборки

DateTo

DocDateType

П

Н




Дата документа

DocDate

DocDateType

П

Н



4.3.2.6. Страничный фильтр


Тип данных «Страничный фильтр» предназначен для организации частичной выборки списка документа для организации страничного списка на сайте.

Наименование типа данных в XSD-схеме: PageFilterType. Описание типа данных приведено в таблице 272.



Таблица 272:Тип данных «Страничный фильтр», PageFilterType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Индекс первого документа

First

ItemIndexType

П

О




Количество документов на странице

Count

ItemCountType

П

О



4.3.2.7. Описание документа


Тип данных «Описание документа» предназначен для передачи данных документа в виде XML, а также списка ссылок на связанные документы. Такими документами для заявления являются ответы СПИ на заявление. В свою очередь, для ответов СПИ связанными документами являются соответствующие заявления

Наименование типа данных в XSD-схеме: EnvelopeType. Описание типа данных приведено в таблице 273.



Таблица 273:Тип данных «Описание документа», EnvelopeType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Ссылки документа

Refs

ReferenceListType

С

О




Данные документа

Content

DocumentContentType

С

О




Свойства документа

Properties

DocumentPropertiesType

С

О



4.3.2.8. Контейнер данных документа


Тип данных «Контейнер данных документа» предназначен для передачи данных документа.

Наименование типа данных в XSD-схеме: DocumentContentType. Описание типа данных приведено в таблице 274.



Таблица 274:Тип данных «Контейнер данных документа», DocumentContentType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

XML-представление документа

В соответствии с типом документа

Any

С

О



4.3.2.9. Атрибуты документа


Тип данных «Атрибуты документа» предназначен для передачи дополнительных данных, связанных с документом.

Наименование типа данных в XSD-схеме: DocumentPropertiesType. Описание типа данных приведено в таблице 275.



Таблица 275:Тип данных «Атрибуты документа», DocumentPropertiesType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Статус

Status

DocumentStatusType

П

О




Строка сообщения

Text

String_1_1000

П

Н

Текст сообщения. В поле может передаваться причины отклонения в если поле «Статус» приняло значение «REJECTED» — Отказано в обработке.

4.3.2.10. Ссылка на документ


Тип данных «Ссылка на документ» предназначен для передачи клиенту веб-сервиса данных, по которым можно получить определенный документ с веб-сервиса, а также непосредственно для получения документа. Существует три типа ссылок: системная, расширенная и внешняя. Для получения документов пригодна любая ссылка. Данный тип является базовым для всех типов ссылок.

Наименование типа данных в XSD-схеме: ReferenceType. Описание типа данных приведено в таблице 276.

Таблица 276:Тип данных «Ссылка на документ», ReferenceType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Тип документа

type

ObjectType

А

О




Системный идентификатор

system_id

SystemIdType

А

Н




Внешний идентификатор

external_id

ExternalIdType

А

Н



4.3.2.11. Расширенная ссылка


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

Данный тип расширяет базовый абстрактный тип ссылки «Ссылка на документ», ReferenceType

Наименование типа данных в XSD-схеме: ExtendedReferenceType. Описание типа данных приведено в таблице 277.

Таблица 277:Тип данных «Расширенная ссылка», ExtendedReferenceType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Номер документа

DocNumber

DocNumberType

П

О




Дата документа

DocDate

DocDateType

П

О




Тип источника обращения

SourceType

SourceType

П

Н

Указывается тип источника обращения из справочника.

Код источника обращения

OrgSourceCode

OrganizationCodeType

П

O

Указывается код источника.

4.3.2.12. Системная ссылка


Тип данных «Системная ссылка» предназначен для возвращения информации о системном идентификаторе документа

Данный тип расширяет базовый абстрактный тип ссылки «Ссылка на документ», ReferenceType

Наименование типа данных в XSD-схеме: SystemReferenceType. Описание типа данных приведено в таблице 278.

Таблица 278:Тип данных «Системная ссылка», SystemReferenceType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Системный идентификатор

system_id

SystemIdType

А

О




Внешний идентификатор

external_id

ExternalIdType

А

Н

Не заполняется.

4.3.2.13. Внешняя ссылка


Тип данных «Внешняя ссылка» предназначен для передачи от внешнего контрагента запроса на получение определенного документа без использования дополнительных полей расширенной ссылки.

Данный тип расширяет базовый абстрактный тип ссылки «Ссылка на документ», ReferenceType

Наименование типа данных в XSD-схеме: OuterReferenceType. Описание типа данных приведено в таблице 279.

Таблица 279:Тип данных «Внешняя ссылка», OuterReferenceType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Системный идентификатор

system_id

SystemIdType

А

Н

Не заполняется.

Внешний идентификатор

external_id

ExternalIdType

А

Н



4.3.2.14. Список ссылок на документы


Тип данных «Список ссылок на документы» предназначен для

Наименование типа данных в XSD-схеме: ReferenceListType. Описание типа данных приведено в таблице 280.



Таблица 280:Тип данных «Список ссылок на документы», ReferenceListType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Расширенная ссылка

ExtRef

ExtendedReferenceType

С

НМ

Допустимо передавать ссылки в любом порядке.

Системная ссылка

SysRef

SystemReferenceType

С

НМ




Внешняя ссылка

OutRef

OuterReferenceType

С

НМ



4.3.2.15. Тип сообщения запроса на передачу заявления


Тип данных «Тип сообщения запроса на передачу заявления» предназначен для передачи заявлению веб-сервису. Является корневым типом сообщения веб-сервиса. Для передачи заявления требуется передать в составе элемента Body SOAP-сообщения элемент данного типа.

Наименование типа данных в XSD-схеме: PutDocumentRequestType. Описание типа данных приведено в таблице 281.



Таблица 281:Тип данных «Тип сообщения запроса на передачу заявления», PutDocumentRequestType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Получатель заявления

Recipient

Address

С

О




Заявление

Document

EnvelopeType

С

О



4.3.2.16. Тип сообщения квитанции о приеме заявления сервисом


Тип данных «Тип сообщения квитанции о приеме заявления сервисом» предназначен для информирования клиента веб-сервиса об удачном приеме документа и возвращения ему ссылки на принятый документ.

Наименование типа данных в XSD-схеме: PutDocumentResponseType. Описание типа данных приведено в таблице 282.



Таблица 282:Тип данных «Тип сообщения квитанции о приеме заявления сервисом», PutDocumentResponseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Расширенная ссылка

ExtRef

ExtendedReferenceType

С

О

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

Внешняя ссылка

OutRef

OuterReferenceType

С

О



4.3.2.17. Тип сообщения запроса списков документов


Тип данных «Тип сообщения запроса списков документов» предназначен для направлению веб-сервису запроса на предоставление клиенту веб-сервиса списка документов. Является корневым типом сообщения веб-сервиса. Для получения списка документов клиенту необходимо сформировать и передать веб-сервису элемент данного типа

Наименование типа данных в XSD-схеме: GetDocumentListRequestType. Описание типа данных приведено в таблице 283.



Таблица 283:Тип данных «Тип сообщения запроса списков документов», GetDocumentListRequestType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Параметры фильрации

Filter

DocumentFilterType

С

О



4.3.2.18. Тип сообщения списка документов


Тип данных «Тип сообщения списка документов» предназначен для передачи клиенту веб-сервиса ранее запрошенного списка документов

Наименование типа данных в XSD-схеме: GetDocumentListResponseType. Описание типа данных приведено в таблице 284.



Таблица 284:Тип данных «Тип сообщения списка документов», GetDocumentListResponseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Список документов

List

DocumentListType

С

О



4.3.2.19. Тип сообщения для получения документа


Тип данных «Тип сообщения для получения документа» предназначен для передачи веб-сервису ссылки на ранее принятый документ или ответ на ранее переданный документ. Является корневым типом сообщения веб-сервиса. Для получения документа клиенту необходимо сформировать и передать веб-сервису элемент данного типа

Наименование типа данных в XSD-схеме: GetDocumentRequestType. Описание типа данных приведено в таблице 285.



Таблица 285:Тип данных «Тип сообщения для получения документа», GetDocumentRequestType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Расширенная ссылка

ExtRef

ExtendedReferenceType

С

О

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

Внешняя ссылка

OutRef

OuterReferenceType

С

О



4.3.2.20. Тип сообщения запрашиваемого документа


Тип данных «Тип сообщения запрашиваемого документа» предназначен для получения от веб-сервиса ранее запрошенного документа.

Наименование типа данных в XSD-схеме: GetDocumentResponseType. Описание типа данных приведено в таблице 286.



Таблица 286:Тип данных «Тип сообщения запрашиваемого документа», GetDocumentResponseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Документ

Document

EnvelopeType

С

О



4.3.2.21. Тип сообщения для получения атрибутов документа


Тип данных «Тип сообщения для получения атрибутов документа» предназначен для передачи веб-сервису ссылки на ранее принятый документ или ответ на ранее переданный документ. Является корневым типом сообщения веб-сервиса. Для получения документа клиенту необходимо сформировать и передать веб-сервису элемент данного типа

Наименование типа данных в XSD-схеме: GetPropertiesRequestType. Описание типа данных приведено в таблице 287.



Таблица 287:Тип данных «Тип сообщения для получения атрибутов документа», GetPropertiesRequestType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Расширенная ссылка

ExtRef

ExtendedReferenceType

С

О

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

Внешняя ссылка

OutRef

OuterReferenceType

С

О



4.3.2.22. Тип сообщения атрибутов документа


Тип данных «Тип сообщения запрашиваемого документа» предназначен для получения от веб-сервиса ранее запрошенного документа.

Наименование типа данных в XSD-схеме: GetPropertiesResponseType. Описание типа данных приведено в таблице 288.



Таблица 288:Тип данных «Тип сообщения запрашиваемого документа», GetPropertiesResponseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Расширенная ссылка

ExtRef

ExtendedReferenceType

С

О

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

Внешняя ссылка

OutRef

OuterReferenceType

С

О




Атрибуты документа

Properties

DocumentPropertiesType









4.3.2.23. Сообщение об ошибке


Тип данных «Сообщение об ошибке» предназначен для передачи от веб-сервиса сообщений об ошибках и о невозможности получения указанного документа.

Наименование типа данных в XSD-схеме: ErrorMessageType. Описание типа данных приведено в таблице 289.



Таблица 289:Тип данных «Сообщение об ошибке», ErrorMessageType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Код ошибки

Code

xs:long

П

О




Текст ошибки

Text

xs:string

П

О



4.3.2.24. Тип сообщения проверки документа


Тип данных «Тип сообщения проверки документа» предназначен для получения от веб-сервиса сообщения о проверки документа.

Наименование типа данных в XSD-схеме: VerificationResultType. Описание типа данных приведено в таблице 290.



Таблица 290:Тип данных «Тип сообщения проверки документа», VerificationResultType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Статус проверки документа

Status

VerificationStatusType

С

О

Указывается общий статус проверки документа.

Этап проверки

Phase

VerificationPhaseType

С

Н

Указываются сведения о результатах и статусе проверки документа.

4.3.2.25. Этап проверки


Тип данных «Этап проверки» предназначен для передачи внешнему контрагенту сведений о результатах проверки документа.

Наименование типа данных в XSD-схеме: VerificationPhaseType. Описание типа данных приведено в таблице 291.



Таблица 291:Тип данных «Этап проверки», VerificationPhaseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Результат проверки

Object

VerificationObject

С

О




Статус проверки

Status

VerificationStatusType

С

О




Текст

TextMessage

xs:string

П

О



4.3.2.26. Тип сообщения запроса для сервиса ЛП


Тип данных «Тип сообщения запроса для сервиса ЛП» предназначен для направления веб-сервису запроса на предоставление клиенту веб-сервиса записи на "Личный прием". Является корневым типом сообщения веб-сервиса. Для записи на "Личный прием" клиенту необходимо сформировать и передать веб-сервису элемент данного типа.

Наименование типа данных в XSD-схеме: EQRequestType. Описание типа данных приведено в таблице 292.

Таблица 292:Тип данных «Тип сообщения запроса для сервиса ЛП», EQRequestType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Получатель заявления

Recipient

Address

С

О




Документ

RequestDocument

DocumentContentType

С

О



4.3.2.27. Тип сообщения ответа для сервиса ЛП


Тип данных «Тип сообщения ответа для сервиса ЛП» предназначен для передачи клиенту веб-сервиса результата записи на "Личный прием" .

Наименование типа данных в XSD-схеме: EQResponseType. Описание типа данных приведено в таблице 293.

Таблица 293:Тип данных «Тип сообщения ответа для сервиса ЛП», EQResponseType

Заголовок элемента

Наименование элемента

Тип данных элемента

П/С/А

О(М)

Дополнительная информация

Документ

ResponseDocument

DocumentContentType

С

О






4.3.3. Операции и сообщения веб-сервиса


Данный веб-сервис поддерживает три операции. С помощью первой операции «put» можно направить завление в ФССП Росии. Ответом будет являться ссылка на документ, по которой этот документ впоследствии можно получить с веб-сервиса операцией «get».

Второй операцией можно получить с веб-сервиса список ранее переданных в ФССП России заявлений. При этом допустима фильтрация списка по ряду критериев. Кроме того, можно запросить лишь часть списка. В результате веб-сервис вернет список документов. К каждому документу будут привязаны одна или две ссылки. По одной из ссылок можно получить исходный документ. По другой—ответ на ранее поданное заявление.

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

Наименование операций, сообщений и типов сообщений веб-сервиса для каждой операции приведено в таблице 294:



Операция

Наименование в WSDL

Вид сообщения

Наименование сообщения (корневой элемент)

Тип данных сообщения

Прием заявлений

put

Запрос

IncomingDocument

PutDocumentRequestType

Ответ-данные

DocumentReceipt

PutDocumentResponseType

Ответ-ошибка

ErrorMessage

ErrorMessageType

Список заявлений

list

Запрос

DocumentListFilter

GetDocumentListRequestType

Ответ-данные

DocumentList

GetDocumentListResponseType

Ответ-ошибка

ErrorMessage

ErrorMessageType

Получение документа

get

Запрос

DocumentReference

GetDocumentRequestType

Ответ-данные

Document

GetDocumentResponseType

Ответ-ошибка

ErrorMessage

ErrorMessageType

Получение атрибутов документа

getProperties

Запрос

PropertiesReference

GetPropertiesRequestType

Ответ-данные

Properties

GetPropertiesResponseType

Ответ-ошибка

ErrorMessage

ErrorMessageType

Получение документа по ссылке

ask

Запрос

RequestDocument

PutDocumentRequestType

Ответ-данные

Document

GetDocumentResponseType

Проверка валидности документа

verify

Запрос

VerificationDocument

PutDocumentRequestType

Ответ-данные

VerificationResult

VerificationResultType

Получение реестра или справочника по ссылке

registry

Запрос

RequestRegistryFile

RegistryFileRequest

Ответ-данные

RegistryFile

RegistryFileResponse

Ответ-ошибка

ErrorMessage

ErrorMessageType

Сервис «Личный прием»

eq

Запрос

EQRequest

EQRequestType

Ответ-данные

EQResponse

EQResponseType

Ответ-ошибка

ErrorMessage

ErrorMessageType


Достарыңызбен бөлісу:
1   ...   54   55   56   57   58   59   60   61   62




©dereksiz.org 2024
әкімшілігінің қараңыз

    Басты бет