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

pkAddr.sql

Сообщения об ошибках

Error_InvalidKLADRObjCode

PROCEDURE Error_InvalidKLADRObjCode(sCode VARCHAR2);

Описание

Генерирует exception «Недопустимый код объекта».

Error_NoKLADRObjWithID

PROCEDURE Error_NoKLADRObjWithID(iID PLS_INTEGER);

Описание

Генерирует exception «Актуальный объект KLADR с ID=... не найден».

Error_NoKLADRObjWithCode

PROCEDURE Error_NoKLADRObjWithCode(sCode VARCHAR2);

Описание

Генерирует exception «Объект KLADR с кодом ... не найден».

Error_NoOADItemWithCode

PROCEDURE Error_NoOADItemWithCode(iCode PLS_INTEGER);

Описание

Генерирует exception «Элемент ОКАТО с кодом ... не найден».

Error_NoOKTMOItemWithCode

PROCEDURE Error_NoOKTMOItemWithCode(iCode PLS_INTEGER);

Описание

Генерирует exception «Элемент ОКТМО с кодом ... не найден».

Error_NoFIASAddrObjWithID

PROCEDURE Error_NoFIASAddrObjWithID(iID PLS_INTEGER);

Описание

Генерирует exception «Адресный объект ФИАС с ID ... не найден».

Error_NoFIASActualAddrObj

PROCEDURE Error_NoFIASActualAddrObj(rAOGUID RAW);

Описание

Генерирует exception «Актуальный адресный объект ФИАС с кодом ... не найден».

Error_NoFIASHouse

PROCEDURE Error_NoFIASHouse(iID PLS_INTEGER);

Описание

Генерирует exception «Дом ФИАС с ID ... не найден».

Error_NoActualFIASHouse

PROCEDURE Error_NoActualFIASHouse(rHouseGUID RAW);

Описание

Генерирует exception «Актуальный дом ФИАС с HouseGUID ... не найден».

Error_NoFIASRoom

PROCEDURE Error_NoFIASRoom(iID PLS_INTEGER);

Описание

Генерирует exception «Помещение ФИАС с ID ... не найдено».

Error_NoActualFIASRoom

PROCEDURE Error_NoActualFIASRoom(rRoomGUID RAW);

Описание

Генерирует exception «Актуальное помещение ФИАС с RoomID ... не найдено».

Error_NoCity

PROCEDURE Error_NoCity(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Генерирует exception «Населённый пункт ... не найден».

Error_NoCityWithAOGUID

PROCEDURE Error_NoCityWithAOGUID(iRegionID PLS_INTEGER, rAOGUID RAW);

Описание

Генерирует exception «Населённый пункт ... не найден».

Error_TooManyCitiesWithAOGUID

PROCEDURE Error_TooManyCitiesWithAOGUID(iRegionID PLS_INTEGER, rAOGUID RAW);

Описание

Генерирует exception «Существует более одного населённого пункта...».

Error_NoStreet

PROCEDURE Error_NoStreet(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Генерирует exception «Улица ... не найдена».

Error_NoStreetWithAOGUID

PROCEDURE Error_NoStreetWithAOGUID(iRegionID PLS_INTEGER, rAOGUID RAW);

Описание

Генерирует exception «Улица ... не найдена».

Error_TooManyStreetsWithAOGUID

PROCEDURE Error_TooManyStreetsWithAOGUID(iRegionID PLS_INTEGER, rAOGUID RAW);

Описание

Генерирует exception «Существует более одной улицы...».

Error_NoAddress

PROCEDURE Error_NoAddress(iRegionID PLS_INTEGER, iAddressID PLS_INTEGER);

Описание

Генерирует exception «Адрес ... не найден».

Error_NoAddress

PROCEDURE Error_NoAddress(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2, sApt VARCHAR2);

Описание

Генерирует exception «Адрес не найден: ...».

Error_NoOADCodeForCity

PROCEDURE Error_NoOADCodeForCity(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Генерирует exception «С населённым пунктом ... не сопоставлен код ОКАТО».

Error_NoKLADRCodeForCity

PROCEDURE Error_NoKLADRCodeForCity(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Генерирует exception «С населённым пунктом ... не сопоставлен код КЛАДР».

Получение сведений об объектах KLADR

GetKLADRSignificantDigits

FUNCTION GetKLADRSignificantDigits(iLevel PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает количество первых значащих цифр в зависимости от уровня объекта KLADR (для уровня 1-6).

GetKLADRFirstDigitPos

FUNCTION GetKLADRFirstDigitPos(iLevel PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает стартовую позицию цифр для соответствующего уровня объекта KLADR (для уровня 1-6).

GetKLADRLevelDigits

FUNCTION GetKLADRLevelDigits(iLevel PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает количество цифр для соответствующего уровня объекта KLADR (для уровня 1-6).

GetKLADRObjLevel

FUNCTION GetKLADRObjLevel(sCode VARCHAR2) RETURN PLS_INTEGER;

Описание

Возвращает уровень объекта по его коду (для уровня 1-4).

LoadKLADRRecByID

FUNCTION LoadKLADRRecByID(iID PLS_INTEGER, iSearchActual PLS_INTEGER, iStrict PLS_INTEGER) RETURN TKLADRRec;

Описание

Загружает информацию об объекте KLADR по его ID (для уровня 1-4).
Параметры:

  • iSearchActual - пытаться ли искать соответствующий актуальный объект для неактуальных (0 - нет, 1 - да)
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

GetKLADRObjIDByCode

FUNCTION GetKLADRObjIDByCode(sCode VARCHAR2, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID объекта KLADR по его коду (для уровня 1-4).
Параметры:

  • sCode - код объекта;
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

LoadKLADRRecByCode

FUNCTION LoadKLADRRecByCode(sCode VARCHAR2, iStrict PLS_INTEGER) RETURN TKLADRRec;

Описание

Загружает информацию об объекте KLADR по его коду (для уровня 1-4).
Параметры:

  • sCode - код объекта;
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

ExtractKLADRObjCode

FUNCTION ExtractKLADRObjCode(sCode VARCHAR2, iLevel PLS_INTEGER, iFullCode PLS_INTEGER) RETURN VARCHAR2;

Описание

Извлекает код объекта указанного уровня из кода объекта произвольного уровня (для уровня 1-4); если iLevel=0, возвращает код объекта по его фактическому уровню; iFullCode - возвращать ли полный 11-значный код (1) или только соответствующие разряды (0).

GetKLADRObjInfo

FUNCTION GetKLADRObjInfo(iID PLS_INTEGER, iDataKind PLS_INTEGER, iLevel PLS_INTEGER := 0, iSearchActual PLS_INTEGER := 1, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

Возвращает информацию об объекте KLADR по его ID (для уровня 1-4)
Параметры:

  • iID - ID объекта в KLADR
  • iDataKind - вид возвращаемых данных: 1 - полный 11-значный код 2 - полный отформатированный 11-значный код 3 - краткий код (2 или 3 знака, в зависимости от значения iLevel) 4 - наименование 5 - признак 6 - почтовый индекс 7 - код ИФНС 8 - код территориального участка ИФНС 9 - код ОКАТО (11 знаков) 10 - наименование+признак (напр., «Алтай Респ», «Тюмень г»)
  • iLevel - уровень объекта в KLADR. Если 0, то получается информация о самом переданном объекте
  • iSearchActual - пытаться ли искать соответствующий актуальный объект для неактуальных (0 - нет, 1 - да)
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception)

Если объект требуемого уровня для указанного объекта не задан, возвращает null (подчинение с пропуском уровней).

GetKLADRObjInfoByCity

FUNCTION GetKLADRObjInfoByCity(iRegionID PLS_INTEGER, iID PLS_INTEGER, iDataKind PLS_INTEGER, iLevel PLS_INTEGER := 0, iSearchActual PLS_INTEGER := 1, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

То же самое, но по ключу населённого пункта из dic_cities.

GetKLADRIDByCity

FUNCTION GetKLADRIDByCity(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Описание

Возвращает ID объекта КЛАДР, соответствующего населённому пункту из dic_cities.
Параметры:

  • iRegionID, iID - ключ населённого пункта;
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

FormatKLADRCode

FUNCTION FormatKLADRCode(sCode VARCHAR2) RETURN VARCHAR2;

Описание

Форматирует и возвращает код КЛАДР.

GetKLADRPathByID

FUNCTION GetKLADRPathByID(iID PLS_INTEGER, iPrependWithCode PLS_INTEGER, iAppendToken PLS_INTEGER, iStrict PLS_INTEGER, sDelimiter VARCHAR2 := '/') RETURN VARCHAR2;

Описание

Возвращает полный путь к элементу КЛАДР по его ID.
Параметры:

  • iPrependWithCode - если <>0, добавляет в начало отформатированный код КЛАДР;
  • iAppendToken - если <>0, после каждого элемента дописывает признак;
  • iStrict - если <>0, вызывает exception, если пункт не найден;
  • sDelimiter - строка-разделитель частей пути.

GetKLADRRootID

FUNCTION GetKLADRRootID(iChildID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код корневого элемента КЛАДР, являющегося родителем заданного элемента. Если элемент не найден, то при iStrict=0 возвращает null, при iStrict!=0 вызывает exception.

ОКАТО

GetOADCodeByCity

FUNCTION GetOADCodeByCity(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Описание

Возвращает код элемента ОКАТО, соответствующего населённому пункту из dic_cities
Параметры:

  • iRegionID, iID - ключ населённого пункта
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

FormatOADCode

FUNCTION FormatOADCode(iCode PLS_INTEGER) RETURN VARCHAR2;

Описание

Форматирует и возвращает код ОКАТО.

GetOADNameByCode

FUNCTION GetOADNameByCode(iCode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование элемента ОКАТО по его коду
Параметры:

  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

GetOADPathByCode

FUNCTION GetOADPathByCode(iCode PLS_INTEGER, iSkipGroups PLS_INTEGER, iPrependWithCode PLS_INTEGER, iStrict PLS_INTEGER, sDelimiter VARCHAR2 := '/') RETURN VARCHAR2;

Описание

Возвращает полный путь к элементу ОКАТО по его коду
Параметры:

  • iSkipGroups - если <>0, то пропускает группы регионов
  • iPrependWithCode - если <>0, добавляет в начало отформатированный код iCode
  • iStrict - если <>0, вызывает exception, если пункт не найден
  • sDelimiter - строка-разделитель частей пути.

GetOADRootCode

FUNCTION GetOADRootCode(iChildCode PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код корневого элемента ОКАТО, являющегося родителем заданного элемента. Если элемент не найден, то при iStrict=0 возвращает null, при iStrict!=0 вызывает exception.

IsInOADBranch

FUNCTION IsInOADBranch(iParentCode PLS_INTEGER, iChildCode PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает 1, если iChildCode является одним из дочерних объектов iParentCode (включая сам iParentCode и его детей), в противном случае 0.

GetOAD_RCOnDate

FUNCTION GetOAD_RCOnDate(iCode PLS_INTEGER, dDate DATE, iStrict PLS_INTEGER) RETURN NUMBER;

Описание

Возвращает районный коэффициент для заданного пункта ОКАТО на заданную дату. Если значение не найдено, то при iStrict=0 возвращает null, при iStrict!=0 вызывает exception.

ОКТМО

FormatOKTMOCode

FUNCTION FormatOKTMOCode(iCode PLS_INTEGER) RETURN VARCHAR2;

Описание

Форматирует и возвращает код ОКТМО.

GetOKTMONameByCode

FUNCTION GetOKTMONameByCode(iCode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование элемента OKTMO по его коду
Параметры:

  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

GetParentOKTMOCode

FUNCTION GetParentOKTMOCode(iCode PLS_INTEGER, iSeekLiterally PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код родительского элемента по ОКТМО.
Параметры:

  • iCode - код ОКТМО, для которого ищется родительский элемент;
  • iSeekLiterally - выполнять ли поиск, последовательно зануляя младшие разряды, если не удалось найти запись в справочнике (0/1);
  • iStrict - определяет поведение при отсутствии записи в справочнике, а в случае поиска путём занулением разрядов - при некорректном коде.

GetRootOKTMOCode

FUNCTION GetRootOKTMOCode(iCode PLS_INTEGER, iIncludeSelf PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код корневого элемента ОКТМО.
Параметры:

  • iCode - код ОКТМО, для которого выполняется поиск;
  • iIncludeSelf - возвращать ли исходный элемент, если он является корневым (0/1).

GetRegionsByOKTMOCode

FUNCTION GetRegionsByOKTMOCode(iCode PLS_INTEGER, iSeekUpward PLS_INTEGER) RETURN uszn.TIntegerList;

Описание

Возвращает список районов Системы с указанным кодом ОКТМО.
Параметры:

  • iCode - код объекта ОКТМО;
  • iSeekUpward - искать ли районы вверх по иерархии ОКТМО (0/1).

Возвращает список районов Системы, имеющих указанный код ОКТМО. Если районов с указанным ОКТМО нет и
iSeekUpward!=0, производится поиск районов, имеющих код родительского объекта ОКТМО. Поиск среди родительских
элементов производится рекурсивно до обнаружения первого непустого результата.
Если районов так и не найдено, возвращает пустой список.

ФИАС: адресные объекты

GetFIASActualAddrObjID

FUNCTION GetFIASActualAddrObjID(rAOGUID RAW, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID актуального адресного объекта ФИАС по его AOGUID.
Параметры:

  • rAOGUID - AOGUID объекта (ключ, уникальный только для актуальных объектов);
  • iStrict - определяет поведение при отсутствии объекта.

GetFIASAddrObjName

FUNCTION GetFIASAddrObjName(iID PLS_INTEGER, iMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование адресного объекта ФИАС.
Параметры:

  • iID - ID записи;
  • iMode - режим отображения: 0 - официальное наименование; 1 - официальное наименование + краткое наименование типа объекта; 2 - краткое наименование типа объекта + официальное наименование; 10 - формализованное наименование; 11 - формализованное наименование + краткое наименование типа объекта; 12 - краткое наименование типа объекта + формализованное наименование.
  • iStrict - определяет поведение при отсутствии объекта.

GetFIASActualAddrObjPath

FUNCTION GetFIASActualAddrObjPath(rAOGUID RAW, iMode PLS_INTEGER, iStrict PLS_INTEGER, sDelimiter VARCHAR2 := '/') RETURN VARCHAR2;

Описание

Возвращает полный путь к актуальному адресному объекту ФИАС по его коду.
Параметры:

  • rAOGUID - AOGUID объекта (ключ, уникальный только для актуальных объектов);
  • iMode - режим отображения: 0 - официальное наименование; 1 - официальное наименование + краткое наименование типа объекта; 2 - краткое наименование типа объекта + официальное наименование; 10 - формализованное наименование; 11 - формализованное наименование + краткое наименование типа объекта; 12 - краткое наименование типа объекта + формализованное наименование.
  • iStrict - определяет поведение при отсутствии объекта;
  • sDelimiter - разделитель между элементами пути.

GetFIASAddrObjRootID

FUNCTION GetFIASAddrObjRootID(iChildID PLS_INTEGER, iActualOnly PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает код корневого адресного объекта ФИАС, являющегося родителем заданного элемента.
Параметры:

  • iChildID - ID объекта, для которого ищется корневой объект;
  • iActualOnly - требуется ли выбрать обязательно актуальный объект (0/1);
  • iStrict - определяет поведение при отсутствии объекта, а также при отсутствии актуального корневого объекта.

GetFIASAddrObjKLADRCityCode

FUNCTION GetFIASAddrObjKLADRCityCode(iID PLS_INTEGER, iFormatted PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает код населённого пункта по КЛАДР для адресного объекта ФИАС.
Параметры:

  • iID - ID записи;
  • iFormatted - форматировать ли результат (0/1);
  • iStrict - определяет поведение при отсутствии объекта.

GetFIASAddrObjKLADRCode

FUNCTION GetFIASAddrObjKLADRCode(iID PLS_INTEGER, iFormatted PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает код населённого пункта или улицы по КЛАДР для адресного объекта ФИАС.
Параметры:

  • iID - ID записи;
  • iFormatted - форматировать ли результат (0/1);
  • iStrict - определяет поведение при отсутствии объекта.

ФИАС: дома

GetFIASHouseID

FUNCTION GetFIASHouseID(rHouseGUID RAW, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Поиск дома по GUID.
Параметры:

  • rHouseGUID - GUID дома;
  • iStrict - определяет поведение при отсутствии дома.

GetFIASHouseDesc

FUNCTION GetFIASHouseDesc(iID PLS_INTEGER, iMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает описание дома ФИАС.
Параметры:

  • iID - ID записи;
  • iMode - режим отображения: 1 - человекочитаемое название полное; 2 - человекочитаемое название краткое;
  • iStrict - определяет поведение при отсутствии объекта.

GetFIASHouseDesc

FUNCTION GetFIASHouseDesc(rHouseGUID RAW, iMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

То же, но дом ищется по HouseGUID.

FindFIASHouse

FUNCTION FindFIASHouse(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2) RETURN RAW;

Описание

Поиск дома ФИАС по адресу Системы.
Параметры:

  • iRegionID - ID района;
  • iCityID - ID населённого пункта;
  • iStreetID - ID улицы;
  • sBldg - номер дома;
  • sBulk - номер корпуса.

Возвращает HouseGUID найденного дома или null, если дом не найден или соответствие неоднозначное.
Чтобы поиск был успешным, необходимо, чтобы улица была привязана к адресному объекту ФИАС.

FindUsedFIASHouse

FUNCTION FindUsedFIASHouse(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2) RETURN RAW;

Описание

Поиск дома ФИАС, уже заданный для адреса Системы.
Параметры:

  • iRegionID - ID района;
  • iCityID - ID населённого пункта;
  • iStreetID - ID улицы;
  • sBldg - номер дома;
  • sBulk - номер корпуса.

Возвращает HouseGUID найденного дома или null, если дом не найден или соответствие неоднозначное.

ФИАС: квартиры

GetFIASRoomFlatType

FUNCTION GetFIASRoomFlatType(iID PLS_INTEGER, iMode PLS_INTEGER) RETURN VARCHAR2 deterministic;

Описание

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

  • iID - ID признака;
  • iMode - режим отображения: 1 - полное наименование; 0 → null; 2 - краткое наименование; 0 → null.

GetFIASRoomType

FUNCTION GetFIASRoomType(iID PLS_INTEGER, iMode PLS_INTEGER) RETURN VARCHAR2 deterministic;

Описание

Возвращает название признака типа комнаты его ID.
Параметры:

  • iID - ID признака;
  • iMode - режим отображения: 1 - полное наименование; 0 → null; 2 - краткое наименование; 0 → null.

GetFIASRoomID

FUNCTION GetFIASRoomID(rRoomGUID RAW, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Поиск актуальной квартиры по GUID.
Параметры:

  • rRoomGUID - GUID квартиры (неуникальный);
  • iStrict - определяет поведение при отсутствии дома.

На самом деле на данный момент в таблице квартир ФИАС все GUID квартир уникальные независимо от признака
актуальности.

GetFIASRoomDesc

FUNCTION GetFIASRoomDesc(iID PLS_INTEGER, iMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает описание квартиры ФИАС.
Параметры:

  • iID - ID записи;
  • iMode - режим отображения: 1 - человекочитаемое название полное; 2 - человекочитаемое название краткое;
  • iStrict - определяет поведение при отсутствии объекта.

GetFIASRoomDesc

FUNCTION GetFIASRoomDesc(rRoomGUID RAW, iMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

То же, но дом ищется по RoomGUID.

FindFIASRoom

FUNCTION FindFIASRoom(rHouseGUID RAW, sApt VARCHAR2) RETURN RAW;

Описание

Поиск квартиры ФИАС.
Параметры:

  • rHouseGUID - GUID дома ФИАС;
  • sApt - номер квартиры.

Возвращает RoomGUID найденной квартиры или null, если квартира не найдена или соответствие неоднозначное.

ГИС ЖКХ

FindUsedGisZkhHouse

FUNCTION FindUsedGisZkhHouse(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2) RETURN RAW;

Описание

Поиск дома по ГИС ЖКХ, заданный для адреса Системы.
Параметры:

  • iRegionID - ID района;
  • iCityID - ID населённого пункта;
  • iStreetID - ID улицы;
  • sBldg - номер дома;
  • sBulk - номер корпуса.

Возвращает GUID дома по ГИС ЖКХ или null, если дом не найден или соответствие неоднозначное.

GetSisHcsHousingObjID

FUNCTION GetSisHcsHousingObjID(iRegionID PLS_INTEGER, iAddrID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID адресного объекта ГИС ЖКХ по адресу.
Параметры:

  • iRegionID, iAddrID - ключ адреса;
  • iStrict - определяет поведение при невозможности получения данных.

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

Районы системы

GetRegionIDByFIASAddrObj

FUNCTION GetRegionIDByFIASAddrObj(iAddrObjID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Поиск рабочего района Системы по ID адресного объекта ФИАС.
Параметры:

  • iAddrObjID - ID адресного объекта;
  • iStrict - определяет поведение при отсутствии соответствия или неоднозначном соответствии.

Адресные справочники Системы

GetCityName

FUNCTION GetCityName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

Возвращает наименование населённого пункта по его ключу в виде «г. Тюмень»
Параметры:

  • iRegionID, iID - ключ населённого пункта;
  • iStrict - поведение при отсутствии населённого пункта (0 - возвращает null, 1 - возникает exception).

GetStreetName

FUNCTION GetStreetName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

Возвращает наименование улицы по её ключу в виде «ул. Ленина»
Параметры:

  • iRegionID, iID - ключ улицы;
  • iStrict - поведение при отсутствии улицы (0 - возвращает null, 1 - возникает exception).

GetCityIDForStreet

FUNCTION GetCityIDForStreet(iRegionID PLS_INTEGER, iStreetID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Описание

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

  • iRegionID, iStreetID - ключ улицы;
  • iStrict - поведение при отсутствии улицы (0 - возвращает null, 1 - возникает exception).

GetCityIDForFIASAddrObj

FUNCTION GetCityIDForFIASAddrObj(iRegionID PLS_INTEGER, rAOGUID RAW, iStrictExists PLS_INTEGER, iStrictUnique PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID населённого пункта по коду адресного объекта ФИАС.
Параметры:

  • iRegionID - ID района;
  • rAOGUID - код адресного объекта ФИАС;
  • iStrictExists - определяет поведение при отсутствии населённого пункта;
  • iStrictUnique - определяет поведение при наличии более одного населённого пункта.

GetStreetIDForFIASAddrObj

FUNCTION GetStreetIDForFIASAddrObj(iRegionID PLS_INTEGER, rAOGUID RAW, iStrictExists PLS_INTEGER, iStrictUnique PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает ID улицы по коду адресного объекта ФИАС.
Параметры:

  • iRegionID - ID района;
  • rAOGUID - код адресного объекта ФИАС;
  • iStrictExists - определяет поведение при отсутствии улицы;
  • iStrictUnique - определяет поведение при наличии более одной улицы.

AllocateNewAddressID

FUNCTION AllocateNewAddressID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает новый свободный ID в r_addresses.

FindAddressID

FUNCTION FindAddressID(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2, sApt VARCHAR2, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

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

  • iRegionID - ID района адреса;
  • iCityID - ID населённого пункта;
  • iStreetID - ID улицы;
  • sBldg - номер дома;
  • sBulk - номер корпуса;
  • sApt - номер квартиры;
  • iStrict - поведение при отсутствии записи (0 - возвращает null, 1 - возникает exception).

GetAddressID

FUNCTION GetAddressID(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2, sApt VARCHAR2) RETURN PLS_INTEGER;

Описание

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

GetAddressData

PROCEDURE GetAddressData(iRegionID PLS_INTEGER, iAddressID PLS_INTEGER, iCityID OUT PLS_INTEGER, iStreetID OUT PLS_INTEGER, sBldg OUT VARCHAR2, sBulk OUT VARCHAR2, sApt OUT VARCHAR2);

Описание

Загружает данные адреса. Параметры:.

GetAddressStr

FUNCTION GetAddressStr(iRegionID PLS_INTEGER, iAddressID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает строку адреса в виде «г. Тюмень, ул. Ленина, д. 1, корп. 3, кв. 14»
Параметры:

  • iRegionID, iAddressID - ключ адреса;
  • iStrict - определяет поведение при отсутствии адреса.

GetAddressStr

FUNCTION GetAddressStr(iRegionID PLS_INTEGER, iCityID PLS_INTEGER, iStreetID PLS_INTEGER, sBldg VARCHAR2, sBulk VARCHAR2, sApt VARCHAR2, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

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

  • iRegionID - ID района населённого пункта и улицы;
  • iCityID - ID населённого пункта;
  • iStreetID - ID улицы;
  • sBldg - номер дома;
  • sBulk - номер корпуса;
  • sApt - номер квартиры;
  • iStrict - поведение при отсутствии объекта (0 - возвращает null, 1 - возникает exception).

GetAddressStr

FUNCTION GetAddressStr(sCity VARCHAR2, sStreet VARCHAR2, sBldg VARCHAR2, sBulk VARCHAR2, sApt VARCHAR2) RETURN VARCHAR2 deterministic;

Описание

То же самое, но вместо ID населённых пунктов и улиц передаётся их название.