Документация iSZN

pkWSStateSvc.sql

Ошибки

Error_NoIPGUDictionary

PROCEDURE Error_NoIPGUDictionary(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER);

Описание

Вызывает exception “Справочник ... не существует”.

Error_NoIPGUDicFields

PROCEDURE Error_NoIPGUDicFields(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER);

Описание

Вызывает exception “Справочник ... не содержит полей”.

Error_InvalidIPGUStatus

PROCEDURE Error_InvalidIPGUStatus(iID PLS_INTEGER);

Описание

Вызывает exception “Ошибочный ID статуса обращения на ЕПГУ”.

Error_NoStateSvcRequest

PROCEDURE Error_NoStateSvcRequest(rMessageGUID RAW);

Описание

Вызывает exception “Обращение ... не существует”.
Параметры:

  • rMessageGUID - GUID сообщения СМЭВ.

Работа со справочниками

GetIPGUDicName

FUNCTION GetIPGUDicName(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER, iDisplayMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование справочника для ЕПГУ по его ключу.
Параметры:

  • iDicRegionID, iDicID - ключ справочника для ЕПГУ;
  • iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey;
  • iStrict - определяет поведение при отсутствии указанного справочника.

GetIPGUDicCode

FUNCTION GetIPGUDicCode(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает код справочника для ЕПГУ по его ключу.
Параметры:

  • iDicRegionID, iDicID - ключ справочника для ЕПГУ;
  • iStrict - определяет поведение при отсутствии указанного справочника.

GetIPGUDicFields

FUNCTION GetIPGUDicFields(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER, iStrict PLS_INTEGER) RETURN TIPGUDicFieldList;

Описание

Возвращает список полей справочника для ЕПГУ по его ключу.
Параметры:

  • iDicRegionID, iDicID - ключ справочника;
  • iStrict - определяет поведение при отсутствии справочника или его полей.

IsIPGUDicAvailForStateSvc

FUNCTION IsIPGUDicAvailForStateSvc(iStateSvcRegionID PLS_INTEGER, iStateSvcID PLS_INTEGER, iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Проверяет, совместим ли справочник с государственной услугой. Если нет, то возвращает 0, иначе 1.
Параметры:

  • iStateSvcRegionID, iStateSvcID - ключ государственной услуги;
  • iDicRegionID, iDicID - ключ справочника ЕПГУ.

Если справочник или государственная услуга не существуют, возвращает 0.

GetIPGUStatusName

FUNCTION GetIPGUStatusName(iID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование статуса сообщения на портале по его ID.
Параметры:

  • iID - ID записи в справочнике статусов обращений на ЕПГУ;
  • iStrict - поведение при отсутствии записи с данным ID.

GetIPGUStatusCode

FUNCTION GetIPGUStatusCode(iID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код статуса сообщения на портале по его ID.
Параметры:

  • iID - ID записи в справочнике статусов обращений на ЕПГУ;
  • iStrict - поведение при отсутствии записи с данным ID.

Обработка запросов

ProcessGetDicList

PROCEDURE ProcessGetDicList(rMessageGUID RAW, iOperationTagID PLS_INTEGER, iIsSignatureValid PLS_INTEGER);

Описание

#DEPRECATED (СМЭВ-2)
Выполняет обработку входящего сообщения на получение списка справочников.
Входящее сообщение уже должно быть разобрано и находиться в r$_parsed_xml_data, и пространство имён СМЭВ настроено.
Параметры:

  • rMessageGUID - GUID сообщения;
  • iOperationTagID - ID тега операции;
  • iIsSignatureValid - признак валидности цифровой подписи (0/1).

ProcessGetDicItems

PROCEDURE ProcessGetDicItems(rMessageGUID RAW, iOperationTagID PLS_INTEGER, iIsSignatureValid PLS_INTEGER);

Описание

#DEPRECATED (СМЭВ-2)
Выполняет обработку входящего сообщения на получение списка элементов справочника.
Входящее сообщение уже должно быть разобрано и находиться в r$_parsed_xml_data, и пространство имён СМЭВ настроено.
Параметры:

  • rMessageGUID - GUID сообщения;
  • iOperationTagID - ID тега операции;
  • iIsSignatureValid - признак валидности цифровой подписи (0/1).

ProcessCreateApplication

PROCEDURE ProcessCreateApplication(rMessageGUID RAW, iOperationTagID PLS_INTEGER, iIsSignatureValid PLS_INTEGER);

Описание

#DEPRECATED (СМЭВ-2)
Выполняет обработку входящего сообщения CreateApplication от сервиса СМЭВ-2.
Если сообщение успешно обработано, создаётся запись обращения за ГУ.
Входящее сообщение уже должно быть разобрано и находиться в r$_parsed_xml_data, и пространство имён СМЭВ настроено.
Параметры:

  • rMessageGUID - GUID сообщения;
  • iOperationTagID - ID тега операции;
  • iIsSignatureValid - признак валидности цифровой подписи (0/1).

GetGetDicItemsSQL

FUNCTION GetGetDicItemsSQL(iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER, iDicKindID PLS_INTEGER) RETURN VARCHAR2;

Описание

#DEPRECATED (СМЭВ-2)
Возвращает SQL-выражение для выборки записей справочника, контролируя также вид справочника.
Параметры:

  • iDicRegionID, iDicID - ключ справочника;
  • iDicKindID - ID вида справочника, константа из числа IDicKindID_xxx.

Если справочник не существует, не является справочником данного вида или SQL-выражение для выборки записей не
задано, возникает exception.

GetDicItems

FUNCTION GetDicItems(
  iDicRegionID PLS_INTEGER, iDicID PLS_INTEGER,
  iSvcRegionID PLS_INTEGER, iSvcID PLS_INTEGER, iRequestRegionID PLS_INTEGER) RETURN uszn.TValueIDObjList;

Описание

#DEPRECATED (СМЭВ-2)
Возвращает список элементов справочника для ЕПГУ.
Параметры:

  • iDicRegionID, iDicID - ключ справочника;
  • iSvcRegionID, iSvcID - ключ государственной услуги;
  • iRequestRegionID - ID района, в который поступило обращение.

Если справочник не существует, возникает exception.

CreateApplication

PROCEDURE CreateApplication(
  rMessageGUID RAW,
  iWarningCount IN OUT NOCOPY PLS_INTEGER, iErrorCount IN OUT NOCOPY PLS_INTEGER, sErrorMsg IN OUT NOCOPY VARCHAR2, cLogData IN OUT NOCOPY CLOB,
  iLogLevel PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL);
-- Возвращает ключ обращения за государственной услугой по GUID сообщения.
-- Параметры:
--   rMessageGUID - GUID сообщения СМЭВ;
--   iStrict      - определяет поведение при отсутствии обращения.
FUNCTION  GetRequestKey(rMessageGUID RAW, iStrict PLS_INTEGER) RETURN uszn.TRgnKey;

Описание

#DEPRECATED (СМЭВ-2)
Создаёт документ-заявление на оказание ГУ в электронном виде.
Параметры:

  • rMessageGUID - GUID сообщения СМЭВ.
  • iWarningCount - количество предупреждений, возникших в процессе обработки;
  • iErrorCount - количество сбоев, возникших в процессе обработки;
  • sErrorMsg - сообщение об ошибке (при наличии ошибки);
  • cLogData - протокол обработки;
  • iLogLevel - начальный уровень отступа в протоколе;
  • iAudOriginID - ID источника события для аудита;
  • sAudNotes - примечания для аудита.

GetRequestKey

FUNCTION GetRequestKey(rMessageGUID RAW, iStrict PLS_INTEGER) RETURN uszn.TRgnKey;

Описание

Возвращает ключ обращения за государственной услугой по GUID сообщения.
Параметры:

  • rMessageGUID - GUID сообщения СМЭВ;
  • iStrict - определяет поведение при отсутствии обращения.

GetRequestKey

PROCEDURE GetRequestKey(
  iSenderRgnID PLS_INTEGER, iSenderID PLS_INTEGER, sCaseNumber VARCHAR2, iFilterRgnID PLS_INTEGER, iStrictExists PLS_INTEGER, iStrictUnique PLS_INTEGER,
  iRequestRgnID OUT PLS_INTEGER, iRequestID OUT PLS_INTEGER);
-- Возвращает ID экземпляра документа, содержащего структурированные данные обращения.
-- Параметры:
--   iRegionID, iRequestID - ключ записи обращения за ГУ.
-- Если обращение не существует, возникает exception.
FUNCTION  GetRequestPDocID(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Поиск обращения за ГУ в электронном виде по номеру заявления в системе-отправителе.
Входные параметры:

  • iSenderRgnID, iSenderID - ключ системы-отправителя;
  • sCaseNumber - номер заявления в системе-отправителе;
  • iFilterRgnID - ID района для фильтрации; фильтрация производится вниз по иерархии районов;
  • iStrictExists - определяет поведение при отсутствии обращения;
  • iStrictUnique - определяет поведение при неоднозначной идентификации обращения.

Выходные параметры:

  • iRequestRgnID, iRequestID - ключ найденного обращения или null, если обращение не найдено.

GetRequestPDocID

FUNCTION GetRequestPDocID(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID экземпляра документа, содержащего структурированные данные обращения.
Параметры:

  • iRegionID, iRequestID - ключ записи обращения за ГУ.

Если обращение не существует, возникает exception.

GetRequestIDForPDoc

FUNCTION GetRequestIDForPDoc(iRegionID PLS_INTEGER, iRequestPDocID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID записи обращения за оказанием ГУ по ключу экземпляра документа, содержащего структурированные данные
обращения.
Параметры:

  • iRegionID, iRequestPDocID - ключ персонального документа, содержащего структурированные данные обращения.

Если обращение не существует или таких обращений более одного, возникает exception.

GetRequestEventAppliedDocs

FUNCTION GetRequestEventAppliedDocs(iRegionID PLS_INTEGER, iRequestEventID PLS_INTEGER, iTranslitNames PLS_INTEGER) RETURN uszn.TSMEVAppliedDocumentList;

Описание

#DEPRECATED (СМЭВ-2)
Возвращает список файлов, прикреплённых к событию по обращению за предоставлением государственной услуги, для
формирования двоичного вложения
Параметры:

  • iRegionID, iRequestEventID - ключ события по обращению за предоставлением ГУ;
  • iTranslitNames - транслитерировать ли кириллические имена файлов (0/1).

Если файлов нет или событие не существует, возвращает пустой список.

RegisterCreatedRequest

FUNCTION RegisterCreatedRequest(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, dReceiveDate DATE) RETURN PLS_INTEGER;

Описание

Регистрирует событие по созданию обращения за предоставлением ГУ после получения обращения в электронном виде.
Параметры:

  • iRegionID, iRequestID - ключ созданного обращения;
  • dReceiveDate - дата и время получения обращения от СМЭВ.

Если обращение не существует, заблокировано или пользователь не имеет необходимых привилегий, возникает exception.
Если события регистрации обращения уже имеется, ничего не делает.
Возвращает ID события изменения статуса обращения или null, если событие не создавалось (было создано ранее).

SetRequestPDocID

PROCEDURE SetRequestPDocID(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, iRequestPDocID PLS_INTEGER);

Описание

Устанавливает в обращении за оказанием ГУ ссылку на экземпляр документа, содержащего структурированные данные
обращения. Если ID экземпляра документа задан, то заполняется также заявитель - им становится владелец данного
документа.
Параметры:

  • iRegionID, iRequestID - ключ записи обращения за ГУ;
  • iRequestPDocID - ID экземпляра документа.

Если обращение не существует, возникает exception.

SetCreateAppPDocStatus

PROCEDURE SetCreateAppPDocStatus(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, bSuccess BOOLEAN);

Описание

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

  • iRegionID, iRequestID - ключ записи обращения за ГУ;
  • bSuccess - было ли заявление успешно обработано.

Если обращение уже имеет статус о создании заявления или выше, ничего не делает.

SendStatusChangeNotify

FUNCTION SendStatusChangeNotify(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Рассылает уведомления об изменении состояния обращения за оказанием государственной услуги.
Отправляется информация о текущем состоянии обращения.
Возвращает ID сообщения СМЭВ-2 или СМЭВ-3, созданного для отправки статуса.
Параметры:

  • iRegionID, iRequestID - ключ записи обращения за оказанием государственной услуги.

Если обращение не существует, возникает exception.
TODO: доработать после вывода из эксплуатации сервиса СМЭВ-2.

SendRequestEventNotification

FUNCTION SendRequestEventNotification(iRegionID PLS_INTEGER, iRequestEventID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Отправляет уведомление о событии по обращению за оказанием ГУ.
Также заполняет у события информацию об отправке уведомления.
Параметры:

  • iRegionID, iRequestEventID - ключ записи события по обращению за оказанием ГУ.

Возвращает ID сообщения СМЭВ-2 или СМЭВ-3, созданного для отправки статуса.
Если событие не существует или уведомление уже отправлялось, возникает exception.
TODO: доработать после вывода из эксплуатации сервиса СМЭВ-2.

Работа с документом обращения

GetArchiveDescription

FUNCTION GetArchiveDescription(Documents uszn.TSMEVAppliedDocumentList) RETURN BLOB;

Описание

#DEPRECATED (СМЭВ-2) Возвращает XML-файл с описанием списка вложений в соответствии с РП сервиса приёма статусов обращения НА ЕПГУ. Если список файлов равен null или пуст, возвращает null.