Документация iSZN
pkWebSvc.sql
[ЯНАО] - Веб-сервис «Предоставление государственных услуг в электронном виде» (обмен со СМЭВ)
StateSvc_Err_InvalidDicID
PROCEDURE StateSvc_Err_InvalidDicID(iDictionaryID PLS_INTEGER);
Описание
Вызывает exception “Недопустимый ID справочника”.
StateSvc_Err_NoDicItem
PROCEDURE StateSvc_Err_NoDicItem(iDictionaryID PLS_INTEGER, iItemID PLS_INTEGER);
Описание
Вызывает exception “Элемент справочника отсутствует”.
StateSvc_Err_InvalidWSMethodID
PROCEDURE StateSvc_Err_InvalidWSMethodID(iMethodID PLS_INTEGER);
Описание
Вызывает exception “Недопустимый ID метода веб-сервиса”.
StateSvc_Err_InvalidStatusID
PROCEDURE StateSvc_Err_InvalidStatusID(iStatusID PLS_INTEGER);
Описание
Вызывает exception “Недопустимый ID состояния обращения”.
StateSvc_Err_InvalidPortalCode
PROCEDURE StateSvc_Err_InvalidPortalCode(iPortalStatusCode PLS_INTEGER);
Описание
Вызывает exception “Недопустимый код состояния обращения на портале”.
StateSvc_Err_NoApplication
PROCEDURE StateSvc_Err_NoApplication(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER);
Описание
Вызывает exception “Обращение не существует”.
StateSvc_Err_TooManyApps
PROCEDURE StateSvc_Err_TooManyApps(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER);
Описание
Вызывает exception “Более одного обращения”.
StateSvc_Err_AppAlreadyExists
PROCEDURE StateSvc_Err_AppAlreadyExists(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER);
Описание
Вызывает exception “Обращение уже существует”.
StateSvc_Err_AlreadyEnqueued
PROCEDURE StateSvc_Err_AlreadyEnqueued(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iMethodID PLS_INTEGER);
Описание
Вызывает exception “Обращение уже поставлено в очередь на обработку”.
Параметры:
- iRegionID - ID района;
- iApplicationID - ID обращения;
- iMethodID - ID вызванного метода веб-сервиса.
StateSvc_Err_LoadedWithErrors
PROCEDURE StateSvc_Err_LoadedWithErrors(iErrorCount PLS_INTEGER, sErrorMsg VARCHAR2);
Описание
Вызывает exception “При обработке обращения произошли сбои”.
Параметры:
- iErrorCount - количество сбоев, возникших при последней попытке загрузки;
- sErrorMsg - сообщение об ошибке, возникшее при последней попытке загрузки.
StateSvc_Err_NotProcessed
PROCEDURE StateSvc_Err_NotProcessed(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iMethodID PLS_INTEGER);
Описание
Вызывает exception “Обращение находится в очереди, но ещё не обработано”.
Параметры:
- iRegionID - ID района;
- iApplicationID - ID обращения;
- iMethodID - ID вызванного метода веб-сервиса.
StateSvc_Err_ProcCancelled
PROCEDURE StateSvc_Err_ProcCancelled(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iMethodID PLS_INTEGER);
Описание
Вызывает exception “Обработка отменена”.
Параметры:
- iRegionID - ID района;
- iApplicationID - ID обращения;
- iMethodID - ID вызванного метода веб-сервиса.
StateSvc_Err_NoPKAssigned
PROCEDURE StateSvc_Err_NoPKAssigned(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER);
Описание
Вызывает exception “Выплата не назначена”.
StateSvc_GetValidLeafRegions
FUNCTION StateSvc_GetValidLeafRegions(iRootRegionID PLS_INTEGER := NULL) RETURN uszn.TIntegerList;
Описание
Возвращает список ID листьевых районов, доступных для создания заявлений. Возвращает ID районов, инициализированных для хранения данных людей/коллективов, с учётом заданного корневого района. Если корневой район не задан (null), в качестве корневого используется район текущего пользователя.
StateSvc_GetDictionaryName
FUNCTION StateSvc_GetDictionaryName(iDictionaryID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование справочника.
StateSvc_GetDictionaryItems
FUNCTION StateSvc_GetDictionaryItems(iRegionID PLS_INTEGER, iDictionaryID PLS_INTEGER) RETURN uszn.TValueIDObjList;
Описание
Возвращает список элементов справочника.
Параметры:
- iRegionID - ID района;
- iDictionaryID - ID справочника.
Если iDictionaryID=0, то возвращается список всех справочников (ID района при этом игнорируется).
Если справочника с заданным ID не существует, возникает exception.
StateSvc_GetDicItemName
FUNCTION StateSvc_GetDicItemName(iRegionID PLS_INTEGER, iDictionaryID PLS_INTEGER, iItemID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование элемента справочника.
Параметры:
- iRegionID - ID района;
- iDictionaryID - ID справочника;
- iItemID - ID элемента справочника.
Если справочника с заданным ID не существует или такой элемент в справочнике отсутствует, возникает exception.
StateSvc_ValidateDicItem
PROCEDURE StateSvc_ValidateDicItem(iRegionID PLS_INTEGER, iDictionaryID PLS_INTEGER, iItemID PLS_INTEGER);
Описание
Проверяет наличие элемента в справочнике.
Параметры:
- iRegionID - ID района;
- iDictionaryID - ID справочника;
- iItemID - ID элемента справочника.
Если справочника с заданным ID не существует или такой элемент в справочнике отсутствует, возникает exception.
StateSvc_GetPKindsForSvc
FUNCTION StateSvc_GetPKindsForSvc(iRegionID PLS_INTEGER, iStateSvcID PLS_INTEGER) RETURN uszn.TValueIDObjList;
Описание
Возвращает список мер социальной поддержки (видов выплат), относящихся к заданной госуслуге.
Параметры:
- iRegionID - ID района;
- iStateSvcID - ID государственной услуги.
Если госуслуга не существует или не подходит для заданного района, возвращает пустой список.
StateSvc_GetWSMethodName
FUNCTION StateSvc_GetWSMethodName(iMethodID PLS_INTEGER, iNameKind PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование метода веб-сервиса.
Параметры:
- iMethodID - ID метода;
- iNameKind - вид наименования: 1 - наименование; 2 - отображаемое наименование;
- iStrict - определяет поведение при отсутствии метода с таким ID.
StateSvc_GetStatusName
FUNCTION StateSvc_GetStatusName(iStatusID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование состояния обращения по ID состояния.
Параметры:
- iStatusID - ID записи статуса обращения в справочнике;
- iStrict - определяет поведение при отсутствии записи.
StateSvc_GetStatusID
FUNCTION StateSvc_GetStatusID(iPortalStatusCode PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID состояния обращения по коду состояния на портале.
Параметры:
- iPortalStatusCode - ID статуса обращения на портале;
- iStrict - определяет поведение при отсутствии записи.
StateSvc_EnqueueAppCreate
PROCEDURE StateSvc_EnqueueAppCreate(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, bApplicationData BLOB, sCallerAddress VARCHAR2 := NULL);
Описание
Помещает в очередь для обработки задачу на создание обращения на предоставление государственной услуги в электронном
виде.
Параметры:
- iRegionID - ID района;
- iApplicationID - номер заявления;
- bApplicationData - данные заявления (XML-файл специального формата).
- sCallerAddress - адрес системы, от которой поступил запрос;
Если обращение с таким ID уже поставлено в очередь или существует в БД, возникает exception.
StateSvc_GetApplicationCount
FUNCTION StateSvc_GetApplicationCount(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает количество обращений на предоставление государственной услуги в электронном виде.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения.
StateSvc_GetApplicationStatus
FUNCTION StateSvc_GetApplicationStatus(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER) RETURN uszn.TStateSvc_AppStatusList;
Описание
Возвращает состояние обращения на предоставление государственной услуги в электронном виде.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения.
Если обращение не существует или существует более одного обращения, возникает exception.
StateSvc_GetAssignedID
FUNCTION StateSvc_GetAssignedID(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID назначения по виду выплаты для обращения на предоставление государственной услуги в электронном виде.
Параметры:
- iRegionID - ID района;
- iAPplicationID - идентификатор обращения.
Если обращение не существует или существует более одного обращения, возникает exception.
Если обращение существует, но выплата не назначена, возвращает null.
StateSvc_GetPayments
FUNCTION StateSvc_GetPayments(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, dPeriodStart DATE, dPeriodEnd DATE) RETURN uszn.TStateSvc_PaymentList;
Описание
Возвращает сведения о выплате по обращению на предоставление государственной услуги в электронном виде.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения;
- dPeriodStart - дата начала периода, за который отображаются сведения;
- dPeriodEnd - дата окончания периода, за который отображаются сведения.
Если обращение не найдено, найдено более одного обращения или выплата не назначена, возникает соответствующий
exception.
Если одна или обе даты, задающие период выборки, не заданы, ограничение с соответствующей стороны отсутствует.
StateSvc_GetAppStatusList
FUNCTION StateSvc_GetAppStatusList(iRegionID PLS_INTEGER, iMaxFailCount PLS_INTEGER) RETURN uszn.TStateSvc_AppStatusNotifyList;
Описание
Возвращает список сведений для передачи статусов обращений на портал государственных услуг. Возвращаются данные
только тех обращений, по которым требуется отправка информации о новом состоянии.
Параметры:
- iRegionID - ID района, в котором сделано обращение; район должен быть листьевым;
- iMaxFailCount - максимально допустимое количество сбоев при отправке статуса на портал; если количество сбоев превысило указанное значение, данное обращение не попадает в список; null - нет ограничений на количество сбоев.
StateSvc_SetLastAppStatus
PROCEDURE StateSvc_SetLastAppStatus(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iPortalStatusCode PLS_INTEGER);
Описание
Устанавливает последнее состояние, отправленное на портал. Вызывается после успешной отправки информации о
состоянии обращения на портал.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения;
- iPortalStatusCode - код статуса на портале.
StateSvc_SendAppStatusFailed
PROCEDURE StateSvc_SendAppStatusFailed(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER);
Описание
Увеличивает на 1 счётчик количества сбоев при отправке последнего состояния на портал.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения.
StateSvc_GetAppStatus
PROCEDURE StateSvc_GetAppStatus(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iConsiderPDocStatus PLS_INTEGER, iStatusID OUT PLS_INTEGER, sMessage OUT VARCHAR2);
Описание
Определяет состояние обращения на предоставление государственной услуги в электронном виде в соответствии со
справочником состояний обращения на портале.
При этом счётчик сбоев при отправке статуса на портал сбрасывается в 0.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения;
- iConsiderPDocStatus - учитывать ли статус из заявления на оказание госуслуг, ID класса=7589 (0/1);
- iStatusID - ID состояния по справочнику;
- sMessage - сообщение для отправки на портал.
StateSvc_SetAppStatus
PROCEDURE StateSvc_SetAppStatus(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iStatusID PLS_INTEGER, sMessage VARCHAR2);
Описание
Устанавливает состояние обращения для передачи на портал.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения;
- iStatusID - ID состояния по справочнику статусов обращений на портале;
- sMessage - текст сообщения для отправки на портал.
StateSvc_UpdateAppStatus
PROCEDURE StateSvc_UpdateAppStatus(iRegionID PLS_INTEGER, iApplicationID PLS_INTEGER, iConsiderPDocStatus PLS_INTEGER);
Описание
Определяет и устанавливает состояние обращения для передачи на портал.
Параметры:
- iRegionID - ID района;
- iApplicationID - идентификатор обращения;
- iConsiderPDocStatus - учитывать ли статус из заявления на оказание госуслуг, ID класса=7589 (0/1);.
[ГУС ТО] - Веб-сервис для получения значений показателей по «Молодым семьям»
GetDwellingPaymentCount
FUNCTION GetDwellingPaymentCount(dDateFrom DATE, dDateTo DATE) RETURN PLS_INTEGER;
Описание
Возвращает количество выданных субсидий (социальных выплат) на приобретение (строительство) жилья.
GetDwellingBuiltArea
Описание
Возвращает площадь жилья, приобретённого (построенного) на выданные субсидии (социальные выплаты) на приобретение (строительство) жилья, кв. м.