Сервис «Адресный регистр»: различия между версиями
Материал из Wiki ГКБ
Перейти к навигации
Перейти к поиску
| Строка 9: | Строка 9: | ||
<br/> | <br/> | ||
| − | В статье описывается принцип работы сервиса по получению адресных сведений объектов недвижимости и регистрационных кодов адресов посредством информационной системы АО «Государственное кредитное бюро», методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки. | + | В данной статье описывается принцип работы сервиса по получению адресных сведений объектов недвижимости и регистрационных кодов адресов посредством информационной системы АО «Государственное кредитное бюро», методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки. |
Версия от 05:50, 31 марта 2023
| Главная страница | Предыдущая страница |
В данной статье описывается принцип работы сервиса по получению адресных сведений объектов недвижимости и регистрационных кодов адресов посредством информационной системы АО «Государственное кредитное бюро», методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки.
Содержание
Техническое описание сервиса AddressRegisterServiceImpl
Сервис AddressRegisterServiceImpl предназначен для запроса на получение адресных сведений (в том числе по историческим данным) и регистрационных кодов адресов.
| Адреса web сервисов: | |
|---|---|
| Тестовый сервис | https://testscbws.mkb.kz/gbdServices/AddressRegisterServiceImpl?wsdl |
| Продуктивный сервис | https://scbws.mkb.kz/gbdServices/AddressRegisterServiceImpl?wsdl |
| Методы сервиса: | 1. getATUs
2. getCityParts 3. getObjects 4. gethAddressTextOfRCA 5. getAddressXMLOfRCA 6. getATUsForSample 7. getAddressTextOfRCA 8. getBreadCrumbs 9. getCityPartsForSample |
При вызове веб-сервиса обязательно указываются следующие параметры:
1. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентификации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.
2. ID пользователя, от имени которого будет выполнена запрашиваемая операция в SOAP Header:
Http Headers: {Authorization=[Basic c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}
SOAP Message: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 - есть значение HTTP Header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм Basic Authentication.
Метод getATUs
Метод getATUs предназначен для получения списка АТЕ, подчиненных указанному в запросе родительскому АТЕ более высокого уровня.
Состав данных запроса на вызов метода getATUs [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса. |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода. |
| 3 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | Для получения первого уровня АТУ РК (области и города республиканского значения) необходимо отправить в запросе параметр territory_id = 1
При повторном вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id. |
| 4 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации.
При передаче значения false метод выдаст ошибку и запрос не будет выполнен. |
Пример SOAP запроса на ВЫЗОВ метода getATUs имеет следующий вид в этом случае: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getATUs>
7. <requestNumber>УНИКАЛЬНЫЙ_НОМЕР_ЗАПРОСА</requestNumber>
8. <method_name>getATUs</method_name>
9. <territory_id>1</territory_id>
10. <consentConfirmed>true</consentConfirmed>
11. </data:getATUs>
12. </soapenv:Body>
13. </soapenv:Envelope>
Пример SOAP ответа на вызов метода getATUs имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getATUsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>D5B937E8-414A-D1BC-8275-CA389D223EE9</messageId>
8. <responseDate>2021-09-13T20:32:40</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <territories>
17. <territory actual="true" category_place="0" category_territory="0" cato="110000000" count_b="0" count_g="0" count_gr="0" count_u="19" id="144254" location="true">
18. <translate_properties>
19. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
20. <name name_kz="Ақмола" name_ru="Акмолинская"/>
21. </translate_properties>
22. </territory>
23. <territory actual="true" category_place="0" category_territory="0" cato="150000000" count_b="0" count_g="0" count_gr="0" count_u="13" id="68381" location="true">
24. <translate_properties>
25. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
26. <name name_kz="Ақтөбе" name_ru="Актюбинская"/>
27. </translate_properties>
28. </territory>
29. <territory actual="true" category_place="0" category_territory="0" cato="190000000" count_b="0" count_g="0" count_gr="0" count_u="20" id="79492" location="true">
30. <translate_properties>
31. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
32. <name name_kz="Алматы" name_ru="Алматинская"/>
33. </translate_properties>
34. </territory>
35. <territory actual="true" category_place="0" category_territory="0" cato="750000000" count_b="0" count_g="0" count_gr="0" count_u="8" id="158106" location="true">
36. <translate_properties>
37. <type code="9" short_value_kz="қ." short_value_ru="г." value_kz="республикалық маңызы бар қаласы" value_ru="Город республиканского значения"/>
38. <name name_kz="Алматы" name_ru="Алматы"/>
39. </translate_properties>
40. </territory>
41. <territory actual="true" category_place="0" category_territory="0" cato="230000000" count_b="0" count_g="0" count_gr="0" count_u="8" id="21030" location="true">
42. <translate_properties>
43. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
44. <name name_kz="Атырау" name_ru="Атырауская"/>
45. </translate_properties>
46. </territory>
47. <territory actual="true" category_place="0" category_territory="0" cato="630000000" count_b="0" count_g="0" count_gr="0" count_u="19" id="31221" location="true">
48. <translate_properties>
49. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
50. <name name_kz="Шығыс Қазақстан" name_ru="Восточно-Казахстанская"/>
51. </translate_properties>
52. </territory>
53. <territory actual="true" category_place="0" category_territory="0" cato="310000000" count_b="0" count_g="0" count_gr="0" count_u="11" id="168532" location="true">
54. <translate_properties>
55. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
56. <name name_kz="Жамбыл" name_ru="Жамбылская"/>
57. </translate_properties>
58. </territory>
59. <territory actual="true" category_place="0" category_territory="0" cato="270000000" count_b="0" count_g="0" count_gr="0" count_u="13" id="51068" location="true">
60. <translate_properties>
61. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
62. <name name_kz="Батыс Қазақстан" name_ru="Западно-Казахстанская"/>
63. </translate_properties>
64. </territory>
65. <territory actual="true" category_place="0" category_territory="0" cato="350000000" count_b="0" count_g="0" count_gr="0" count_u="18" id="202313" location="true">
66. <translate_properties>
67. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
68. <name name_kz="Қарағанды" name_ru="Карагандинская"/>
69. </translate_properties>
70. </territory>
71. <territory actual="true" category_place="0" category_territory="0" cato="390000000" count_b="0" count_g="0" count_gr="0" count_u="20" id="125189" location="true">
72. <translate_properties>
73. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
74. <name name_kz="Қостанай" name_ru="Костанайская"/>
75. </translate_properties>
76. </territory>
77. <territory actual="true" category_place="0" category_territory="0" cato="430000000" count_b="0" count_g="0" count_gr="0" count_u="9" id="158628" location="true">
78. <translate_properties>
79. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
80. <name name_kz="Қызылорда" name_ru="Кызылординская"/>
81. </translate_properties>
82. </territory>
83. <territory actual="true" category_place="0" category_territory="0" cato="470000000" count_b="0" count_g="0" count_gr="0" count_u="7" id="109099" location="true">
84. <translate_properties>
85. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
86. <name name_kz="Маңғыстау" name_ru="Мангистауская"/>
87. </translate_properties>
88. </territory>
89. <territory actual="true" category_place="0" category_territory="0" cato="710000000" count_b="0" count_g="0" count_gr="1" count_u="4" id="106724" location="true">
90. <translate_properties>
91. <type code="9" short_value_kz="қ." short_value_ru="г." value_kz="республикалық маңызы бар қаласы" value_ru="Город республиканского значения"/>
92. <name name_kz="Нұр-Сұлтан" name_ru="Нур-Султан"/>
93. </translate_properties>
94. </territory>
95. <territory actual="true" category_place="0" category_territory="0" cato="550000000" count_b="0" count_g="0" count_gr="0" count_u="13" id="2" location="true">
96. <translate_properties>
97. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
98. <name name_kz="Павлодар" name_ru="Павлодарская"/>
99. </translate_properties>
100. </territory>
101. <territory actual="true" category_place="0" category_territory="0" cato="590000000" count_b="0" count_g="0" count_gr="0" count_u="14" id="113406" location="true">
102. <translate_properties>
103. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
104. <name name_kz="Солтүстік Қазақстан" name_ru="Северо-Казахстанская"/>
105. </translate_properties>
106. </territory>
107. <territory actual="true" category_place="0" category_territory="0" cato="610000000" count_b="0" count_g="0" count_gr="0" count_u="17" id="178760" location="true">
108. <translate_properties>
109. <type code="7" short_value_kz="обл." short_value_ru="обл." value_kz="облысы" value_ru="Область"/>
110. <name name_kz="Түркістан" name_ru="Туркестанская"/>
111. </translate_properties>
112. </territory>
113. <territory actual="true" category_place="0" category_territory="0" cato="790000000" count_b="0" count_g="2" count_gr="0" count_u="4" id="178771" location="true">
114. <translate_properties>
115. <type code="9" short_value_kz="қ." short_value_ru="г." value_kz="республикалық маңызы бар қаласы" value_ru="Город республиканского значения"/>
116. <name name_kz="Шымкент" name_ru="Шымкент"/>
117. </translate_properties>
118. </territory>
119. </territories>
120. </data>
121. </responseData>
122. </Person>
123. </return>
124. </ns2:getATUsResponse>
125. </soap:Body>
126. </soap:Envelope>
Пример SOAP запроса на ВЫЗОВ метода getATUs имеет следующий вид в этом случае: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getATUs>
7. <requestNumber>УНИКАЛЬНЫЙ_НОМЕР_ЗАПРОСА</requestNumber>
8. <method_name>getATUs</method_name>
9. <territory_id>158106</territory_id>
10. <consentConfirmed>true</consentConfirmed>
11. </data:getATUs>
12. </soapenv:Body>
13. </soapenv:Envelope>
Пример SOAP ответа на вызов метода getATUs имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getATUsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>0A74ED14-11DE-55D4-00C1-A7EF7499868E</messageId>
8. <responseDate>2021-09-13T18:25:54</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <territories>
17. <territory actual="true" category_place="0" category_territory="1" cato="751210000" count_b="5" count_g="144" count_gr="5" count_u="0" id="138439" location="true">
18. <translate_properties>
19. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
20. <name name_kz="Алатау" name_ru="Алатауский"/>
21. </translate_properties>
22. </territory>
23. <territory actual="true" category_place="0" category_territory="1" cato="751110000" count_b="1" count_g="116" count_gr="1" count_u="0" id="137626" location="true">
24. <translate_properties>
25. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
26. <name name_kz="Алмалы" name_ru="Алмалинский"/>
27. </translate_properties>
28. </territory>
29. <territory actual="true" category_place="0" category_territory="1" cato="751310000" count_b="1" count_g="125" count_gr="1" count_u="0" id="140362" location="true">
30. <translate_properties>
31. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
32. <name name_kz="Ауэзовский" name_ru="Ауэзовский"/>
33. </translate_properties>
34. </territory>
35. <territory actual="true" category_place="0" category_territory="1" cato="751410000" count_b="4" count_g="264" count_gr="4" count_u="0" id="141496" location="true">
36. <translate_properties>
37. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
38. <name name_kz="Бостандық" name_ru="Бостандыкский"/>
39. </translate_properties>
40. </territory>
41. <territory actual="true" category_place="0" category_territory="1" cato="751510000" count_b="3" count_g="256" count_gr="3" count_u="0" id="139305" location="true">
42. <translate_properties>
43. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
44. <name name_kz="Жетісу" name_ru="Жетысуский"/>
45. </translate_properties>
46. </territory>
47. <territory actual="true" category_place="0" category_territory="1" cato="751710000" count_b="0" count_g="517" count_gr="1" count_u="0" id="142245" location="true">
48. <translate_properties>
49. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
50. <name name_kz="Медеу" name_ru="Медеуский"/>
51. </translate_properties>
52. </territory>
53. <territory actual="true" category_place="0" category_territory="1" cato="751810000" count_b="1" count_g="110" count_gr="5" count_u="0" id="251403" location="true">
54. <translate_properties>
55. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
56. <name name_kz="Наурызбай" name_ru="Наурызбайский"/>
57. </translate_properties>
58. </territory>
59. <territory actual="true" category_place="0" category_territory="1" cato="751910000" count_b="5" count_g="395" count_gr="8" count_u="0" id="136194" location="true">
60. <translate_properties>
61. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
62. <name name_kz="Турксіб" name_ru="Турксибский"/>
63. </translate_properties>
64. </territory>
65. </territories>
66. </data>
67. </responseData>
68. </Person>
69. </return>
70. </ns2:getATUsResponse>
71. </soap:Body>
72. </soap:Envelope>
Состав данных ОТВЕТА на запрос метода getATUs [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <territories> предназначен для передачи списка АТЕ. Каждая АТЕ представлена в списке тегом <territory>. Этот тег имеет следующие основные параметры: | |||
| 2 | id | xs:integer | Идентификатор АТЕ и БД АР |
| 3 | cato | xs:varchar | Код КАТО |
| 4 | category_territory | xs:integer | Категория территории {0 – регион; 1 – населенный пункт} |
| 5 | category_place | xs:integer | Категория населенного пункта {1 – городской тип; 2 – сельский} |
| 6 | location | xs: string | Расположение в границах родителя {0 – административных; 1 – административно-территориальных} |
| 7 | count_u | xs:integer | Передает количество дочерних АТЕ |
| 8 | count_g | xs:integer | Передает количество дочерних СЧНП |
| 9 | count_gr | xs:integer | Передает количество ЗУ зарегистрированных на данной СЧНП |
| 10 | count_b | xs:integer | Передает количество зарегистрированных на данной СЧНП ПО |
| 11 | actual | xs: string | Признак актуальности объекта {1 – актуален; 0 – упразднен} |
| Тег <territory> имеет переводные параметры (тег – <translate_properties>): | |||
| 12 | type | Символьный | Задает тип АТЕ, имеет краткую форму |
| 13 | code | xs:integer | Код значения |
| 14 | short_value_kz | xs:varchar | Краткое обозначение типа на казахском языке |
| 15 | short_value_ru | xs:varchar | Краткое обозначение типа на русском языке |
| 16 | value_kz | xs:varchar | Значение типа на казахском языке |
| 17 | value_ru | xs:varchar | Значение типа на русском языке |
| 18 | name | Символьный | Задает название (топоним) АТЕ |
| 19 | name_kz | xs:varchar | Название на казахском языке |
| 20 | name_ru | xs:varchar | Название на русском языке |
Метод getCityParts
Метод предназначен для получения списка СЧНП, принадлежащих указанному в запросе элементу более высокого уровня. Родительским элементом может быть АТЕ или другая СЧНП.
Состав данных запроса на ВЫЗОВ метода getCityParts [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 3 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 4 | Идентификатор СЧНП | geonim_id | xs:integer | Да | Тег <geonims> предназначен для передачи списка СЧНП |
| 5 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId></soapenv:Header>
4. <soapenv:Body>
5. <data:getCityParts>
6. <requestNumber>1234</requestNumber>
7. <method_name>getCityParts</method_name>
8. <territory_id>142245</territory_id>
9. <geonim_id>0</geonim_id>
10. <consentConfirmed>true</consentConfirmed>
11. </data:getCityParts>
12. </soapenv:Body>
13. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getCityParts [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <geonims> предназначен для передачи списка СЧНП.
СЧНП представлен в списке тегом <geonim>. Этот тег имеет следующие основные параметры: | |||
| 1 | actual | xs: string | Признак актуальности объекта {1 – актуален; 0 – упразднен} |
| 2 | count_b | xs:integer | Передает количество зарегистрированных на данной СЧНП ПО |
| 3 | count_g | xs:integer | Передает количество дочерних СЧНП |
| 4 | count_gr | xs:integer | Передает количество ЗУ, зарегистрированных на данной СЧНП |
| 5 | id | xs:integer | Идентификатор СЧНП и БД АР |
| 6 | location | xs: string | Расположение в границах родителя {0 – административных; 1 – административно-территориальных} |
| Тег < geonims > имеет переводные параметры (тег – <translate_properties>): | |||
| 7 | type | Символьный | Задает тип СЧНП, имеет краткую форму |
| 8 | code | xs:integer | Код значения |
| 9 | short_value_kz | xs:varchar | Краткое обозначение типа на казахском языке |
| 10 | short_value_ru | xs:varchar | Краткое обозначение типа на русском языке |
| 11 | value_kz | xs:varchar | Значение типа на казахском языке |
| 12 | value_ru | xs:varchar | Значение типа на русском языке |
| 13 | name | Символьный | Задает название (топоним) СЧНП |
| 14 | name_kz | xs:varchar | Название на казахском языке |
| 15 | name_ru | xs:varchar | Название на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getCityPartsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>0D6DEFAC-7874-B307-D048-35ED1AC9EFEA</messageId>
8. <responseDate>2021-09-15T22:18:40</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <geonims>
17. <geonim actual="true" count_b="24" count_g="0" count_gr="34" id="262676" location="true">
18. <translate_properties>
19. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
20. <name name_kz="1" name_ru="1"/>
21. </translate_properties>
22. </geonim>
23. <geonim actual="true" count_b="4" count_g="0" count_gr="4" id="143281" location="true">
24. <translate_properties>
25. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
26. <name name_kz="1-ая Бригадная" name_ru="1-ая Бригадная"/>
27. </translate_properties>
28. </geonim>
29. <geonim actual="true" count_b="32" count_g="0" count_gr="32" id="143101" location="true">
30. <translate_properties>
31. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
32. <name name_kz="11 кірпішзауыты" name_ru="11 кирпичнозаводская"/>
33. </translate_properties>
34. </geonim>
35. <geonim actual="true" count_b="9" count_g="0" count_gr="20" id="260521" location="true">
36. <translate_properties>
37. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
38. <name name_kz="2" name_ru="2"/>
39. </translate_properties>
40. </geonim>
41. <geonim actual="true" count_b="8" count_g="0" count_gr="8" id="143532" location="true">
42. <translate_properties>
43. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
44. <name name_kz="2 курчатова" name_ru="2 курчатова"/>
45. </translate_properties>
46. </geonim>
47. <geonim actual="true" count_b="8" count_g="0" count_gr="11" id="143279" location="true">
48. <translate_properties>
49. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
50. <name name_kz="2 линия" name_ru="2 линия"/>
51. </translate_properties>
52. </geonim>
53. <geonim actual="true" count_b="24" count_g="0" count_gr="24" id="142370" location="true">
54. <translate_properties>
55. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
56. <name name_kz="Многоводная 2" name_ru="2 Многоводная"/>
57. </translate_properties>
58. </geonim>
59. <geonim actual="true" count_b="14" count_g="0" count_gr="14" id="143370" location="true">
60. <translate_properties>
61. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
62. <name name_kz="2-ші Карімбаев" name_ru="2-ая Каримбаева"/>
63. </translate_properties>
64. </geonim>
65. <geonim actual="true" count_b="2" count_g="0" count_gr="17" id="269718" location="true">
66. <translate_properties>
67. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
68. <name name_kz="3" name_ru="3"/>
69. </translate_properties>
70. </geonim>
71. <geonim actual="true" count_b="9" count_g="0" count_gr="28" id="262351" location="true">
72. <translate_properties>
73. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
74. <name name_kz="4" name_ru="4"/>
75. </translate_properties>
76. </geonim>
77. <geonim actual="true" count_b="189" count_g="0" count_gr="316" id="281014" location="true">
78. <translate_properties>
79. <type code="15" short_value_kz="даңғ." short_value_ru="пр." value_kz="Даңғылы" value_ru="Проспект"/>
80. <name name_kz="Нұрсұлтан Назарбаев" name_ru="Нұрсұлтан Назарбаев"/>
81. </translate_properties>
82. </geonim>
83. <geonim actual="true" count_b="2" count_g="0" count_gr="2" id="269096" location="true">
84. <translate_properties>
85. <type code="63" short_value_kz="б/с" short_value_ru="с/т" value_kz="Бағбандық серіктестік" value_ru="Садоводческое товарищество"/>
86. <name name_kz="Облпрокуратура" name_ru="Облпрокуратура"/>
87. </translate_properties>
88. </geonim>
89. <geonim actual="true" count_b="46" count_g="0" count_gr="77" id="142957" location="true">
90. <translate_properties>
91. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
92. <name name_kz="Обсерватория" name_ru="Обсерватория"/>
93. </translate_properties>
94. </geonim>
95. <geonim actual="true" count_b="49" count_g="0" count_gr="53" id="143061" location="true">
96. <translate_properties>
97. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
98. <name name_kz="Одесса" name_ru="Одесская"/>
99. </translate_properties>
100. </geonim>
101. <geonim actual="true" count_b="141" count_g="0" count_gr="164" id="142306" location="true">
102. <translate_properties>
103. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
104. <name name_kz="Олимпийская" name_ru="Олимпийская"/>
105. </translate_properties>
106. </geonim>
107. <geonim actual="true" count_b="30" count_g="0" count_gr="39" id="143388" location="true">
108. <translate_properties>
109. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
110. <name name_kz="Омарова Ж" name_ru="Омаровой Ж"/>
111. </translate_properties>
112. </geonim> <geonim actual="true" count_b="36" count_g="0" count_gr="43" id="285062" location="true">
113. <translate_properties>
114. <type code="11" short_value_kz="көш." short_value_ru="ул." value_kz="көшесі" value_ru="улица"/>
115. <name name_kz="Қосалқа" name_ru="Қосалқа"/>
116. </translate_properties>
117. </geonim>
118. <geonim actual="true" count_b="0" count_g="0" count_gr="1" id="242540" location="true">
119. <translate_properties>
120. <type code="63" short_value_kz="б/с" short_value_ru="с/т" value_kz="Бағбандық серіктестік" value_ru="Садоводческое товарищество"/>
121. <name name_kz="№9 Домоуправление" name_ru="№9 Домоуправление"/>
122. </translate_properties>
123. </geonim>
124. </geonims>
125. </data>
126. </responseData>
127. </Person>
128. </return>
129. </ns2:getCityPartsResponse>
130. </soap:Body>
131. </soap:Envelope>
Метод getObjects
Метод предназначен для получения РКА и идентификатора ПО, ВО и ЗУ по введенным параметрам.
Состав данных запроса на ВЫЗОВ метода getObjects [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | ИИН субъекта | iin | xs:string | Да | Значение должно содержать 12 цифр |
| 3 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 4 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 5 | Идентификатор СЧНП | geonim_id | xs:integer | Да | Тег <geonims> предназначен для передачи списка СЧНП. |
| 6 | Категория ПО | category | xs:integer | Да | Категория ПО |
| 7 | Номер родительского ПО | building_number | xs:integer | Да | Номер родительского ПО |
| 8 | Код значения в справочнике | room_code | xs:integer | Да | Код значения в справочнике |
| 9 | Номер ВО | room_number | xs:integer | Да | Номер ВО |
| 10 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getObjects>
7. <requestNumber>1234</requestNumber>
8. <iin>850414300265</iin>
9. <method_name>getObjects</method_name>
10. <territory_id>142245</territory_id>
11. <geonim_id>281014</geonim_id>
12. <category>2</category>
13. <building_number>100</building_number>
14. <room_code>0</room_code>
15. <room_number>0</room_number>
16. <consentConfirmed>true</consentConfirmed>
17. </data:getObjects>
18. </soapenv:Body>
19. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getObjects [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <object> предназначен для передачи РКА объекта адресации. Тег имеет следующие параметры: | |||
| 1 | оbject_id | xs:integer | Идентификатор ПО |
| 2 | rca | xs:string | Регистрационный код объекта адресации |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getObjectsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>E72C6913-3850-A1D0-C2EF-D27E94C504AF</messageId>
8. <responseDate>2021-09-15T22:31:21</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <object id="4634801" rca="0201300118385505"/>
17. </data>
18. </responseData>
19. </Person>
20. </return>
21. </ns2:getObjectsResponse>
22. </soap:Body>
23. </soap:Envelope>
Метод gethAddressTextOfRCA
Метод предназначен для получения истории адресов объекта адресации по известному РКА в виде списка сформированных текстовых строк.
Состав данных запроса на ВЫЗОВ метода gethAddressTextOfRCA [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | ИИН субъекта | iin | xs:string | Да | Значение должно содержать 12 цифр |
| 3 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 4 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 5 | Идентификатор СЧНП | geonim_id | xs:integer | Да | Тег <geonims> предназначен для передачи списка СЧНП. |
| 6 | Регистрационный код объекта адресации | rca | xs:string | Да | Регистрационный код объекта адресации |
| 7 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:gethAddressTextOfRCA>
7. <requestNumber>1234</requestNumber>
8. <iin>850414300265</iin>
9. <method_name>gethAddressTextOfRCA</method_name>
10. <territory_id>142245</territory_id>
11. <geonim_id>281014</geonim_id>
12. <rca>0201300118385505</rca>
13. <consentConfirmed>true</consentConfirmed>
14. </data:gethAddressTextOfRCA>
15. </soapenv:Body>
</soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода gethAddressTextOfRCA [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <addresses> служит контейнером для передачи списка исторических адресов. Тег <address> предназначан для передачи адреса в виде строки текста. Метод возвращает адрес в полной форме (с полными значениями типов). Этот тег имеет следующие основные параметры: | |||
| 1 | begin_time | xs:varchar | Время, когда был присвоен/изменен адрес объекта |
| 2 | value_kz | xs:varchar | Значение типа на казахском языке |
| 3 | value_ru | xs:varchar | Значение типа на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:gethAddressTextOfRCAResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>CCF0418E-06B1-479F-47D4-CA7D353D91E8</messageId>
8. <responseDate>2021-09-13T22:00:35</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <addresses>
17. <address begin_time="2017-12-21T19:17:55" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Фурманов даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Фурманов, дом 100"/>
18. <address begin_time="2017-12-21T19:25:25" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
19. <address begin_time="2017-12-21T19:32:19" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Фурманов даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Фурманов, дом 100"/>
20. <address begin_time="2017-12-21T19:34:04" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
21. <address begin_time="2018-05-13T00:36:10" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
22. <address begin_time="2018-05-13T00:36:11" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
23. <address begin_time="2018-06-25T10:12:23" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
24. <address begin_time="2018-06-25T10:12:58" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
25. <address begin_time="2018-06-25T10:13:27" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
26. <address begin_time="2018-06-25T10:14:03" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
27. <address begin_time="2019-05-15T11:54:20" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
28. <address begin_time="2019-05-15T11:54:36" value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй 100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом 100"/>
29. </addresses>
30. </data>
31. </responseData>
32. </Person>
33. </return>
34. </ns2:gethAddressTextOfRCAResponse>
35. </soap:Body>
</soap:Envelope>
Метод getAddressXMLOfRCA
Метод предназначен для получения адреса объекта адресации по известному РКА в виде XML структуры.
Состав данных запроса на ВЫЗОВ метода getAddressXMLOfRCA [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | ИИН субъекта | iin | xs:string | Да | Значение должно содержать 12 цифр |
| 3 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 4 | Регистрационный код объекта адресации | rca | xs:string | Да | Регистрационный код объекта адресации |
| 5 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getAddressXMLOfRCA>
7. <requestNumber>1234</requestNumber>
8. <iin>850414300265</iin>
9. <method_name>getAddressXMLOfRCA</method_name>
10. <rca>0201300118385505</rca>
11. <consentConfirmed>true</consentConfirmed>
12. </data:getAddressXMLOfRCA>
13. </soapenv:Body>
14. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getAddressXMLOfRCA [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <territory> предназначен для передачи списка АТЕ. Каждая АТЕ представлена в списке тегом <territory>. Этот тег имеет следующие основные параметры: | |||
| 1 | category_place | xs:integer | Категория населенного пункта {1 – городской тип; 2 – сельский} |
| 2 | category_territory | xs:integer | Категория территории {0 – регион; 1 – населенный пункт} |
| 3 | cato | xs:varchar | Код КАТО |
| 4 | id | xs:integer | Идентификатор АТЕ и БД АР |
| 5 | location | xs: string | Расположение в границах родителя {0 – административных; 1 – административно-территориальных} |
| Тег < territories> имеет переводные параметры (тег – <translate_properties>): | |||
| 6 | type | Символьный | Задает тип АТЕ, имеет краткую форму |
| 7 | code | xs:integer | Код значения |
| 8 | short_value_kz | xs:varchar | Краткое обозначение типа на казахском языке |
| 9 | short_value_ru | xs:varchar | Краткое обозначение типа на русском языке |
| 10 | value_kz | xs:varchar | Значение типа на казахском языке |
| 11 | value_ru | xs:varchar | Значение типа на русском языке |
| 12 | name | Символьный | Задает название (топоним) АТЕ |
| 13 | name_kz | xs:varchar | Название на казахском языке |
| 14 | name_ru | xs:varchar | Название на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getAddressXMLOfRCAResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>B062B81C-B9AE-E30F-5AAB-91772752DDD9</messageId>
8. <responseDate>2021-09-13T17:25:39</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <territories>
17. <territory category_place="0" category_territory="0" cato="100000000" id="1" location="true">
18. <translate_properties>
19. <type code="10" short_value_kz="Республика" short_value_ru="Республика" value_kz="Республикасы" value_ru="Республика"/>
20. <name name_kz="Қазақстан" name_ru="Казахстан"/>
21. </translate_properties>
22. </territory>
23. <territory category_place="0" category_territory="0" cato="750000000" id="158106" location="true">
24. <translate_properties>
25. <type code="9" short_value_kz="қ." short_value_ru="г." value_kz="республикалық маңызы бар қаласы" value_ru="Город республиканского значения"/>
26. <name name_kz="Алматы" name_ru="Алматы"/>
27. </translate_properties>
28. </territory>
29. <territory category_place="0" category_territory="1" cato="751710000" id="142245" location="true">
30. <translate_properties>
31. <type code="8" short_value_kz="ауд." short_value_ru="р-н" value_kz="қала ішіндегі аудан" value_ru="Район в городе"/>
32. <name name_kz="Медеу" name_ru="Медеуский"/>
33. </translate_properties>
34. </territory>
35. </territories>
36. <geonims>
37. <geonim id="281014" location="true">
38. <translate_properties>
39. <type code="15" short_value_kz="даңғ." short_value_ru="пр." value_kz="Даңғылы" value_ru="Проспект"/>
40. <name name_kz="Нұрсұлтан Назарбаев" name_ru="Нұрсұлтан Назарбаев"/>
41. </translate_properties>
42. </geonim>
43. </geonims>
44. <object_part>
45. <building actual="true" addid="" description="" distance="0" id="4634801" name="" number="100" rca="0201300118385505" temp="false" this_is="usual">
46. <translate_properties>
47. <type code="200" value_kz="үй" value_ru="дом"/>
48. </translate_properties>
49. </building>
50. </object_part>
51. </data>
52. </responseData>
53. </Person>
54. </return>
55. </ns2:getAddressXMLOfRCAResponse>
56. </soap:Body>
</soap:Envelope>
Метод getATUsForSample
Метод предназначен для поиска АТЕ во всех дочерних объектах указанного АТЕ, имеющих в своем названии указанный параметр.
Состав данных запроса на ВЫЗОВ метода getATUsForSample [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 3 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 4 | Предназначен для описания наименования искомого объекта | sample_value | xs:string | Да | Тег <sample> предназначен для описания наименования искомого объекта. Тег имеет следующие параметры:
value – полное или частичное наименование искомого объекта |
| 5 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getATUsForSample>
7. <requestNumber>1234</requestNumber>
8. <method_name>getATUsForSample</method_name>
9. <territory_id>158106</territory_id>
10. <sample_value>Медеу</sample_value>
11. <consentConfirmed>true</consentConfirmed>
12. </data:getATUsForSample>
13. </soapenv:Body>
14. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getATUsForSample [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <territory> предназначен для передачи списка АТЕ. Каждая АТЕ представлена в списке тегом <territory>. Этот тег имеет следующие основные параметры: | |||
| 1 | category_place | xs:integer | Категория населенного пункта {1 – городской тип; 2 – сельский} |
| 2 | category_territory | xs:integer | Категория территории {0 – регион; 1 – населенный пункт} |
| 3 | cato | xs:varchar | Код КАТО |
| 4 | count_b | xs:integer | Передает количество зарегистрированных на данной СЧНП ПО |
| 5 | count_g | xs:integer | Передает количество дочерних СЧНП |
| 6 | count_gr | xs:integer | Передает количество ЗУ зарегистрированных на данной СЧНП |
| 7 | count_u | xs:integer | Передает количество дочерних АТЕ |
| 8 | id | xs:integer | Идентификатор АТЕ и БД АР |
| 9 | location | xs: string | Расположение в границах родителя {0 – административных; 1 – административно-территориальных} |
| Тег < territories> имеет переводные параметры (тег – <translate_properties>): | |||
| 10 | name | Символьный | Задает название (топоним) АТЕ |
| 11 | name_kz | xs:varchar | Название на казахском языке |
| 12 | name_ru | xs:varchar | Название на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getATUsForSampleResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>5817E5DE-F981-00DE-43C0-3C50D9EA2526</messageId>
8. <responseDate>2021-09-13T18:28:51</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <territories>
17. <territory category_place="0" category_territory="1" cato="751710000" count_b="0" count_g="517" count_gr="1" count_u="0" id="142245" location="true">
18. <translate_properties>
19. <name name_kz="Медеу қала ішіндегі аудан" name_ru="Район в городе Медеуский"/>
20. </translate_properties>
21. </territory>
22. </territories>
23. </data>
24. </responseData>
25. </Person>
26. </return>
27. </ns2:getATUsForSampleResponse>
28. </soap:Body>
29. </soap:Envelope>
Метод getAddressTextOfRCA
Метод предназначен для получения адреса объекта адресации по известному РКА в виде сформированной текстовой строки.
Состав данных запроса на ВЫЗОВ метода getAddressTextOfRCA [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 3 | Регистрационный код объекта адресации | rca | xs:string | Да | Регистрационный код объекта адресации |
| 4 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getAddressTextOfRCA>
7. <requestNumber>1234</requestNumber>
8. <method_name>getAddressTextOfRCA</method_name>
9. <rca>0201300118385505</rca>
10. <consentConfirmed>true</consentConfirmed>
11. </data:getAddressTextOfRCA>
12. </soapenv:Body>
13. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getAddressTextOfRCA [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <addresses> служит контейнером для передачи списка исторических адресов. Тег <address> предназначен для передачи адреса в виде строки текста. Метод возвращает адрес в полной форме (с полными значениями типов). Этот тег имеет следующие основные параметры: | |||
| 1 | value_kz | xs:varchar | Значение типа на казахском языке |
| 2 | value_ru | xs:varchar | Значение типа на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getAddressTextOfRCAResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>406682E9-68EC-6FA4-236F-5910443BEE71</messageId>
8. <responseDate>2021-09-13T17:33:45</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <addresses>
17. <address value_kz="Қазақстан Республикасы, Алматы қаласы, Медеу ауданы, Нұрсұлтан Назарбаев даңғылы, үй №100" value_ru="Республика Казахстан, город Алматы, район Медеуский, проспект Нұрсұлтан Назарбаев, дом №100"/>
18. </addresses>
19. </data>
20. </responseData>
21. </Person>
22. </return>
23. </ns2:getAddressTextOfRCAResponse>
24. </soap:Body>
25. </soap:Envelope>
Метод getBreadCrumbs
Метод предназначен для получения адреса СЧНП в виде XML структуры.
Состав данных запроса на ВЫЗОВ метода getBreadCrumbs [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 3 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 4 | Идентификатор СЧНП | geonim_id | xs:integer | Да | Тег <geonims> предназначен для передачи списка СЧНП |
| 5 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getBreadCrumbs>
7. <requestNumber>1234</requestNumber>
8. <method_name>getBreadCrumbs</method_name>
9. <territory_id>142245</territory_id>
10. <geonim_id>281014</geonim_id>
11. <consentConfirmed>true</consentConfirmed>
12. </data:getBreadCrumbs>
13. </soapenv:Body>
14. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getBreadCrumbs [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <territory> предназначен для передачи списка АТЕ. Каждая АТЕ представлена в списке тегом <territory>. Этот тег имеет следующие основные параметры: | |||
| 1 | category_place | xs:integer | Категория населенного пункта {1 – городской тип; 2 – сельский} |
| 2 | category_territory | xs:integer | Категория территории {0 – регион; 1 – населенный пункт} |
| 3 | cato | xs:varchar | Код КАТО |
| 4 | count_b | xs:integer | Передает количество зарегистрированных на данной СЧНП ПО |
| 5 | count_g | xs:integer | Передает количество дочерних СЧНП |
| 6 | count_u | xs:integer | Передает количество дочерних АТЕ |
| 7 | id | xs:integer | Идентификатор АТЕ и БД АР |
| 8 | location | xs: string | Расположение в границах родителя {0 – административных; 1 – административно-территориальных} |
| Тег < territories> имеет переводные параметры (тег – <translate_properties>): | |||
| 9 | type | Символьный | Задает тип АТЕ, имеет краткую форму |
| 10 | code | xs:integer | Код значения |
| 11 | short_value_kz | xs:varchar | Сокращенная категория на казахском языке |
| 12 | short_value_ru | xs:varchar | Сокращенная категория на русском языке |
| 13 | value_kz | xs:varchar | Категория объекта на казахском языке |
| 14 | value_ru | xs:varchar | Категория объекта на русском языке |
| 15 | name | Символьный | Задает название (топоним) АТЕ |
| 16 | name_kz | xs:varchar | Название на казахском языке |
| 17 | name_ru | xs:varchar | Название на русском языке |
Пример ответа на вызов метода getBreadCrumbs [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getBreadCrumbsResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>BD8A67FF-8174-669E-2FB5-28E7DF693759</messageId>
8. <responseDate>2021-09-15T23:01:13</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <territories>
17. <territory category_place="0" category_territory="0" cato="100000000" count_b="0" count_g="0" count_u="17" id="1" location="true">
18. <translate_properties>
19. <type code="10" short_value_kz="Республика" short_value_ru="Республика" value_kz="Республикасы" value_ru="Республика"/>
20. <name name_kz="Қазақстан" name_ru="Казахстан"/>
21. </translate_properties>
22. </territory>
23. <territory category_place="0" category_territory="0" cato="750000000" count_b="0" count_g="0" count_u="8" id="158106" location="true">
24. <translate_properties>
25. <type code="9" short_value_kz="қ." short_value_ru="г." value_kz="республикалық маңызы бар қаласы" value_ru="Город республиканского значения"/>
26. <name name_kz="Алматы" name_ru="Алматы"/>
27. </translate_properties>
28. </territory>
29. </territories>
30. <geonims>
31. <geonim actual="true" count_b="189" count_g="0" id="281014" location="true" s_ats_id="142245">
32. <translate_properties>
33. <type code="15" short_value_kz="даңғ." short_value_ru="пр." value_kz="Даңғылы" value_ru="Проспект"/>
34. <name name_kz="Нұрсұлтан Назарбаев" name_ru="Нұрсұлтан Назарбаев"/>
35. </translate_properties>
36. </geonim>
37. </geonims>
38. </data>
39. </responseData>
40. </Person>
41. </return>
42. </ns2:getBreadCrumbsResponse>
43. </soap:Body>
44. </soap:Envelope>
Метод getCityPartsForSample
Метод предназначен для поиска СЧНП во всех дочерних объектах указанного СЧНП, имеющих в своем названии указанный параметр.
Состав данных запроса на ВЫЗОВ метода getCityPartsForSample [Показать ответ]
| № | Наименование | Поле | Формат | Обязательность | Примечание |
|---|---|---|---|---|---|
| 1 | Номер запроса | requestNumber | xs:string | Да | Значение должно содержать не повторяющийся уникальный номер запроса |
| 2 | Название метода | method_name | xs:string | Да | Значение должно содержать название метода |
| 3 | Идентификатор родительской АТЕ | territory_id | xs:integer | Да | При вызове данного метода необходимо посылать ранее полученный нужный id (области и города республиканского значения) в поле territory_id |
| 4 | Идентификатор СЧНП | geonim_id | xs:integer | Да | Тег <geonims> предназначен для передачи списка СЧНП. |
| 5 | Тег <sample> предназначен для описания наименования искомого объекта. Тег имеет следующие параметры:
value – полное или частичное наименование искомого объекта. |
sample_value | xs:string | Да | Тег <sample> предназначен для описания наименования искомого объекта. Тег имеет следующие параметры:
value – полное или частичное наименование искомого объекта |
| 6 | Согласие субъекта | consentConfirmed | xs:string | Да | Указыватеся значение true, означающее согласие субъекта на получение информации |
Пример вызова метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.gbd.chdb.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getCityPartsForSample>
7. <requestNumber>1234</requestNumber>
8. <method_name>getCityPartsForSample</method_name>
9. <territory_id>142245</territory_id>
10. <geonim_id>281014</geonim_id>
11. <sample_value>Нұрсұлтан</sample_value>
12. <consentConfirmed>true</consentConfirmed>
13. </data:getCityPartsForSample>
14. </soapenv:Body>
15. </soapenv:Envelope>
Состав данных ОТВЕТА на запрос метода getCityPartsForSample [Показать ответ]
| № | Поле | Формат | Примечание |
|---|---|---|---|
| Тег <geonims> предназначен для передачи списка СЧНП.
СЧНП представлен в списке тегом <geonim>. Этот тег имеет следующие основные параметры: | |||
| 1 | count_b | xs:integer | Передает количество зарегистрированных на данной СЧНП ПО |
| 2 | count_g | xs:integer | Передает количество дочерних СЧНП |
| 3 | s_ats_id | xs:integer | Идентификатор родительского АТЕ |
| Тег < geonims > имеет переводные параметры (тег – <translate_properties>): | |||
| 4 | name | Символьный | Задает название (топоним) СЧНП |
| 5 | name_kz | xs:varchar | Название на казахском языке |
| 6 | name_ru | xs:varchar | Название на русском языке |
Пример ответа на вызов метода AddressRegisterServiceImpl с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getCityPartsForSampleResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <Person>
6. <responseInfo>
7. <messageId>256BEEC9-897F-0BC4-BBAE-3D96F07D501D</messageId>
8. <responseDate>2021-09-15T23:09:33</responseDate>
9. <status>
10. <code>SCSS001</code>
11. <message>Сообщение успешно обработано</message>
12. </status>
13. </responseInfo>
14. <responseData>
15. <data>
16. <geonims>
17. <geonim count_b="189" count_g="0" id="281014" s_ats_id="142245">
18. <translate_properties>
19. <name name_kz="Нұрсұлтан Назарбаев Даңғылы" name_ru="Проспект Нұрсұлтан Назарбаев"/>
20. </translate_properties>
21. </geonim>
22. </geonims>
23. </data>
24. </responseData>
25. </Person>
26. </return>
27. </ns2:getCityPartsForSampleResponse>
28. </soap:Body>
29. </soap:Envelope>
Код/Текст ошибки/сообщения
При обработке запроса методы AddressRegisterServiceImpl могут возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]
| Код/Текст ошибки/сообщения | Описание ошибки/сообщения | Примечание |
|---|---|---|
| VAL-JSR-001 | 1.Значение обязательного поля UserId не должно быть пустым
2.Значение обязательного поля "requestNumber" не должно быть пустым 3.Значение обязательного поля "method_name" не должно быть пустым 4.Значение обязательного поля "territory_id" не должно быть пустым 5.Значение обязательного поля "geonim_id" не должно быть пустым 6.Значение обязательного поля "sample_value" не должно быть пустым 7.Значение обязательного поля "rca" не должно быть пустым 8.Значение обязательного поля "category" не должно быть пустым 9.Значение обязательного поля "room_code" не должно быть пустым 10.Значение обязательного поля "room_number" не должно быть пустым |
|
| Если вводить в полях неправильные/несоответствующие значения | Объект не найден | |
| VAL-R-004 | Для получения отчета необходимо подтвердить согласие субъекта на запрос его данных из ГБД | |
| ScbSystemFault,
SBF-AD-1 |
Пользователь «%s» не имеет прав для выполнения действия | |
| FAULT-015 | 1. Сервис на стороне ГБД не доступен
2. Нет ответа от сервиса в течение 150000 ms. Повторите запрос снова. 3. Нет ответа от сервиса по данному запросу. Повторите запрос снова. |
|
| VAL-WAIT-001 | Ожидание ответа от сервиса |
Основные понятия и сокращения
Основные понятия и сокращения [Показать ответ]
| Наименование | Определение |
|---|---|
| РК | Республика Казахстан |
| МЦРИиАП РК | Министерство цифрового развития, инноваций и аэрокосмической промышленности Республики Казахстан |
| ГКБ | АО «Государственное кредитное бюро» |
| Сервис | Сервис по получению данных из ГБД «Адресный регистр» |
| ГБД АР | Государственная база данных «Адресный регистр» |
| Веб-сервис | Набор операций (программных методов), которые реализуют определенную логику, и доступны для вызова по сети путем обмена SOAP-сообщениями |
| HTTPS | Hypertext Transfer Protocol Secure - протокол передачи гипертекста |
| SOAP | Simple Object Access Protocol - протокол, основанный на XML для передачи сообщений при интеграции ИС |
| XML | eXtensible Markup Language - расширяемый язык разметки, используемый для хранения и передачи данных в структурированном и машиночитаемом формате |
| WSDL | Web Service Definition Language - стандарт описания интерфейсов веб-сервисов |
| АТУ РК | Административно-территориальное управление Республики Казахстан |
| АТЕ | Административно-территориальная единица - составная часть системы административно-территориального устройства Республики Казахстан (село, поселок, сельский округ, район в городе, город, район, область) |
| РКА | Регистрационный код адреса - уникальный код объекта адресации, генерируемый ГБД АР, является уникальным и постоянным в течение всего жизненного цикла объекта адресации |
| КАТО | Классификатор административно-территориальных объектов |
| СЧНП | Составная часть населенного пункта (микрорайоны, площади, проспекты, бульвары, улицы, переулки, парки, скверы, мосты и другие части) |
| ПО | Первичный объект |
| ВО | Вторичный объект |
| ЗУ | Земельный участок |
| Главная страница | Предыдущая страница |