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

pkXML_SisHcs.sql

Формирование запросов

GetFixedNSPrefix

FUNCTION GetFixedNSPrefix(sNSURI VARCHAR2) RETURN VARCHAR2;

Описание

Возвращает фиксированный префикс для указанного URI пространства имён. Если URI не распознан, возникает exception.

AddNSAttr

PROCEDURE AddNSAttr(sAttribs IN OUT NOCOPY VARCHAR2, sNSURI VARCHAR2);

Описание

Добавляет атрибут объявления пространства имён.
Параметры:

  • sAttribs - список атрибутов;
  • sNSURI - URi пространства имён.

Префикс добавляется фиксированный, в зависимости от URI. Если URI не распознан, возникает exception.

GetMessageGuidTag

FUNCTION GetMessageGuidTag(rGUID RAW, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Описание

Формирует тег <base:MessageGuid>.
Параметры:

  • rGUID - GUID;
  • iStrict - определяет поведение при отсутствующем значении rGUID.

GetRequestHeaderTag

FUNCTION GetRequestHeaderTag(Header uszn.pkSisHcs.TRequestHeader) RETURN VARCHAR2;

Описание

Формирует тег заголовка запроса (RequestHeader или ISRequestHeader).
Параметры:

  • Header - структурированные данные заголовка;.

GetRequestEnvelope

FUNCTION GetRequestEnvelope(Header uszn.pkSisHcs.TRequestHeader, cData CLOB, sDataAttribs VARCHAR2, sRequestTag VARCHAR2, sNSURI VARCHAR2, sVersion VARCHAR2) RETURN BLOB;

Описание

Формирует конверт запроса в ГИС ЖКХ.
Параметры:

  • Header - данные заголовка;
  • cData - предметные данные запроса;
  • sDataAttribs - дополнительные атрибуты к предметным данным, в том числе необходимые объявления префиксов пространств имён; пространство имён base и корневого запроса тега объявлять не нужно, они будут добавлены функцией автоматически;
  • sRequestTag - корневой тег запроса;
  • sNSURI - URI пространства имён корневого тега запроса;
  • sVersion - версия сервиса для атрибута base:version; если null, атрибут не добавляется.
  • Префикс пространства имён для корневого тега запроса определяется автоматически, из числа фиксированных.

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

GetPollEnvelope

FUNCTION GetPollEnvelope(Header uszn.pkSisHcs.TRequestHeader, rSisHcsGUID RAW) RETURN BLOB;

Описание

Формирует конверт запроса getState в ГИС ЖКХ.
Параметры:

  • Header - данные заголовка;
  • rSisHcsGUID - GUID запроса, по которому запрашивается состояние обработки, в ГИС ЖКХ.

GetTransportGuidTag

FUNCTION GetTransportGuidTag(rGUID RAW, sNSPrefix VARCHAR2, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Описание

Формирует тег <TransportGuid>.
Параметры:

  • rGUID - GUID;
  • sNSPrefix - префикс пространства имён;
  • iStrict - определяет поведение, если не заполнен GUID.

GetCancelTag

FUNCTION GetCancelTag(sNSPrefix VARCHAR2) RETURN VARCHAR2;

Описание

Формирует тег <Cancel> для удаления записи, ранее импортированной в ГИС ЖКХ.
Параметры:

  • sNSPrefix - префикс пространства имён.

GetNsiRefTagData

FUNCTION GetNsiRefTagData(NsiRef uszn.pkSisHcs.TNsiRef, sDicName VARCHAR2 := NULL) RETURN VARCHAR2;

Описание

Формирует данные для тега типа nsiRef.
Параметры:

  • NsiRef - структурированные данные ссылки на справочник;
  • sDicName - наименование справочника (для сообщений об ошибке).

Если обязательные данные не заполнены, возникает exception.

GetMspPersonTagData

FUNCTION GetMspPersonTagData(PC uszn.pkSisHcs.TMspPerson) RETURN VARCHAR2;

Описание

Возвращает данные для тега физического лица:
Параметры:

  • PC - структурированные данные физического лица;.

GetSubsidyOverviewTag

FUNCTION GetSubsidyOverviewTag(Overview uszn.pkSisHcs.TSubsidyPCOverview) RETURN VARCHAR2;

Описание

Формирует тег общих сведений о гражданине, получающем субсидию.
Параметры:

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

GetSubsidyLoadCalculationTag

FUNCTION GetSubsidyLoadCalculationTag(Calc uszn.pkSisHcs.TSubsidyCalc) RETURN VARCHAR2;

Описание

Формирует тег с данными расчёта субсидии.
Параметры:

  • Calc - структурированные сведения о расчёте.

GetCompensOverviewTag

FUNCTION GetCompensOverviewTag(Overview uszn.pkSisHcs.TCompensPCOverview) RETURN VARCHAR2;

Описание

Формирует тег общих сведений о гражданине, получающем компенсацию расходов.
Параметры:

  • Overview - структурированные сведения о гражданине, получающем компенсацию расходов.

GetCompensLoadCalculationTag

FUNCTION GetCompensLoadCalculationTag(Calc uszn.pkSisHcs.TCompensCalc) RETURN VARCHAR2;

Описание

Формирует тег с данными расчёта компенсации расходов.
Параметры:

  • Calc - структурированные сведения о расчёте.

GetMspLoadPaymentTag

FUNCTION GetMspLoadPaymentTag(Payment uszn.pkSisHcs.TMspPayment, iTarget PLS_INTEGER) RETURN VARCHAR2;

Описание

Формирует тег с данными оплаты МСП.
Параметры:

  • Payment - структурированные сведения об оплате;
  • iTarget - целевая операция: 1 - импорт субсидий, 2 - импорт компенсации расходов.

Разбор ответов

ParseResultHeader

PROCEDURE ParseResultHeader(iSOAPHeaderTagID PLS_INTEGER, Header OUT uszn.pkSisHcs.TResultHeader);

Описание

Выполняет разбор заголовка ответа на запрос.
Входные параметры:

  • iSOAPHeaderTagID - ID тега <soap:Header>.

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

  • Header - разобранные данные заголовка ответа.

Если необходимые данные в XML отсутствуют, возникает exception.

ParseAckRequest

PROCEDURE ParseAckRequest(iSOAPBodyTagID PLS_INTEGER, AckRequest OUT uszn.pkSisHcs.TAckRequest);

Описание

Выполняет разбор квитанции (синхронного ответа на отправку запроса).
Входные параметры:

  • iSOAPBodyTagID - ID тега <soap:Body>.

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

  • AckRequest - квитанция.

Если необходимые данные в XML отсутствуют, возникает exception.

ParseErrorMessage

PROCEDURE ParseErrorMessage(iTagID PLS_INTEGER, ErrorMessage OUT uszn.pkSisHcs.TErrorMessage);

Описание

Выполняет разбор тега <base:ErrorMessage> и <base:Error>.
Входные параметры:

  • iTagID - ID тега <base:ErrorMessage> или <base:Error>.

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

  • ErrorMessage - структурированные данные сообщения об ошибке.

ParseFaultDetail

PROCEDURE ParseFaultDetail(iDetailTagID PLS_INTEGER, iIsParsed OUT PLS_INTEGER, ErrorMessage OUT uszn.pkSisHcs.TErrorMessage);

Описание

Выполняет разбор детализации SoapFault.
Входные параметры:

  • iDetailTagID - ID тега <detail>;
  • iIsParsed - были ли найдены данные об ошибке (0/1).

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

  • ErrorMessage - структурированные данные сообщения об ошибке.

ParseCommonResult

PROCEDURE ParseCommonResult(iTagID PLS_INTEGER, Result OUT uszn.pkSisHcs.TCommonResult);

Описание

Выполняет разбор тега типа CommonResultType.
Входные параметры:

  • iTagID - ID тега.

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

  • Result - структурированные данные результата.

ParseGetStateResult

PROCEDURE ParseGetStateResult(iSOAPBodyTagID PLS_INTEGER, Result OUT uszn.pkSisHcs.TGetStateResult, iResultTagID OUT PLS_INTEGER);

Описание

Выполняет разбор общей части ответа на запрос getStateRequest.
Входные параметры:

  • iSOAPBodyTagID - ID тега <soap:Body>.

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

  • Result - структурированные данные ответа;
  • iResultTagID - ID тега getStateResult.

Если необходимые данные в XML отсутствуют, возникает exception.