(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
В данной статье описывается принцип работы сервиса по получению сведений о адресной социальной помощи (АСП) физических лиц (далее - Сервис) посредством информационной системы АО «Государственное кредитное бюро» (далее - ГКБ), методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки.
Описание сервиса АСП (AddressSocialAssistanceImplService)
При вызове веб-сервиса обязательно указываются следующие параметры:
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.mtszn.scb.kz">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getAddressSocialAssistance/>
7. </soapenv:Body>
8. </soapenv:Envelope>
где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 - есть значение HTTP Header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм Basic Authentication.
Метод getAddressSocialAssistance
Метод getAddressSocialAssistance сервиса AddressSocialAssistanceImplService предназначен для получения сведений о статусе и наличии активных выплат многодетным семьям, семьям-получателям адресной социальной помощи (АСП).
Таблица 1. Состав данных запроса на получение информации (метод getAddressSocialAssistance) [Показать ответ]
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| 1
|
ИИН субъекта
|
iin
|
xs:string
|
Да
|
Значение должно содержать 12 цифр
|
| 2
|
Номер запроса
|
requestNumber
|
xs:string
|
Да
|
Данное поле должно быть уникальным и не должно повторяться при каждом запросе.
|
Метод getAddressSocialAssistanceUseToken
Метод getAddressSocialAssistanceUseToken сервиса AddressSocialAssistanceImplService предназначен для получения сведений о статусе и наличии активных выплат многодетным семьям, семьям-получателям адресной социальной помощи (АСП). Данный метод вызывается с помощью ключа безопасности «Токен».
Таблица 2. Состав данных запроса на получение информации (метод getAddressSocialAssistanceUseToken) [Показать ответ]
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| 1
|
ИИН субъекта
|
iin
|
xs:string
|
Да
|
Значение должно содержать 12 цифр
|
| 2
|
Номер запроса
|
requestNumber
|
xs:string
|
Да
|
Данное поле должно быть уникальным и не должно повторяться при каждом запросе.
|
| 3
|
Токен КДП
|
token
|
xs:string
|
Да
|
Наличие согласия субъекта на предоставление информации из ГБД
|
Состав данных ответа на запрос методов getAddressSocialAssistance и getAddressSocialAssistanceUseToken
Таблица 3. Состав данных ответа [Показать ответ]
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| 1
|
Ответ на запрос
|
return/response
|
SyncsendMessageResponse
|
Да
|
|
| 2
|
Информация об ответе
|
response/responseInfo
|
SyncMessageInfoResponse
|
Да
|
|
| 3
|
Идентификатор сообщения в системе получателя
|
messageId
|
xs:string
|
Да
|
|
| 4
|
Идентификатор цепочки сообщения в системе получателя запроса
|
correlationId
|
xs:string
|
Нет
|
|
| 5
|
Дата ответа в системе получателя запроса
|
responseDate
|
xs:dateTime
|
Да
|
|
| 6
|
Объект «Информация о статусе»
|
status
|
StatusInfo
|
Да
|
|
| 6.1
|
Код статуса
|
status/code
|
xs:string
|
Да
|
|
| 8
|
Сообщение о статусе
|
status/message
|
xs:string
|
Да
|
|
| 9
|
Идентификатор сессии на ШЭП
|
sessionId
|
guid
|
Нет
|
|
| 10
|
Объект «Данные ответа»
|
response/responseData
|
responsedata
|
Да
|
|
| 11
|
Объект «Данные сообщения»
|
responseData/data
|
xs:Anytype
|
Нет
|
|
| Состав данных ответа о найденной АСП
(PersonLargeFamilyResponse)
|
| 12
|
ИИН
|
iin
|
xs:string
|
Да
|
|
| 13
|
Фамилия
|
surname
|
xs:string
|
Да
|
|
| 14
|
Имя
|
firstname
|
xs:string
|
Да
|
|
| 15
|
Отчество
|
secondname
|
xs:string
|
Нет
|
|
| 16
|
Пол
|
sex
|
xs:string
|
Да
|
|
| 17
|
Дата рождения
|
birthDate
|
xs:date
|
Да
|
ГГГГ-ММ-ДД
|
| 18
|
Наличие статуса
|
state
|
xs:string
|
Да
|
Принимает следующие значения:
ASP - Получатель АСП;
notASP – не получатель АСП;
notfound - данные на найдены
|
| 19
|
Назначенная сумма АСП на семью
|
summASP
|
xs:double
|
Да/Нет
|
Поле обязательно для передачи, если значение поля «Наличие статуса» равно ASP.
|
| 20
|
Дата первой выплаты
|
firstPaymentDate
|
xs:date
|
Да
|
Формат:
ГГГГ-ММ-ДД
Поле обязательно для передачи, если значение поля «Наличие статуса» равно ASP.
|
| 21
|
Дата последней выплаты
|
lastPaymentDate
|
xs:date
|
Да
|
Формат:
ГГГГ-ММ-ДД
Поле обязательно для передачи, если значение поля «Наличие статуса» равно ASP.
|
| 22
|
Количество детей в семье
|
numberOfChildren
|
xs:string
|
Да
|
|
| 23
|
Состав семьи - общее количество членов семьи получателей АСП
|
numberFamilyMembers
|
xs:string
|
Да
|
|
| 24
|
Среднедушевой месячный доход на каждого члена семьи
|
sddFamilyMembers
|
xs:double
|
Да
|
|
Пример вызова метода getAddressSocialAssistance
Пример вызова метода getAddressSocialAssistance [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.mtszn.scb.kz/">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getAddressSocialAssistance>
7. <iin>ИИН_субъекта</iin>
8. </data:getAddressSocialAssistance>
9. </soapenv:Body>
10. </soapenv:Envelope>
Пример вызова метода getAddressSocialAssistanceUseToken
Пример вызова метода getAddressSocialAssistanceUseToken [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.mtszn.scb.kz/">
2. <soapenv:Header>
3. <userId> xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx </userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getAddressSocialAssistanceUseToken>
7. <requestNumber>номер запроса</requestNumber>
8. <iin> ИИН субъекта</iin>
9. <token>Токен КДП</token>
10. </data:getAddressSocialAssistanceUseToken>
11. </soapenv:Body>
12. </soapenv:Envelope>
Пример ответа на вызов методов getAddressSocialAssistance и getAddressSocialAssistanceUseToken
Пример ответа на вызов методов getAddressSocialAssistance и getAddressSocialAssistanceUseToken с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getAddressSocialAssistanceResponse xmlns:ns2="http://data.mtszn.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <response>
6. <responseInfo>
7. <messageId>4f6a343f-cfb6-4b27-8601-22f9f5aa0c61</messageId>
8. <correlationId/>
9. <responseDate>2019-12-13T12:10:13.905+06:00</responseDate>
10. <status>
11. <code>SCSS001</code>
12. <message>Message has been processed successfully</message>
13. </status>
14. <sessionId/>
15. </responseInfo>
16. <responseData>
17. <data xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
18. <![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
19. <response>
20. <iin>ИИН_субъекта</iin>
21. <surname>Фамилия</surname>
22. <firstname>Имя</firstname>
23. <secondname>Отчество</secondname>
24. <sex>F</sex>
25. <birthDate>1998-08-23</birthDate>
26. <state>ASP</state>
27. <summASP>1699488</summASP>
28. <firstPaymentDate>2019-04-01</firstPaymentDate>
29. <lastPaymentDate>2020-03-01</lastPaymentDate>
30. <numberOfChildren>4</numberOfChildren>
31. <numberFamilyMembers>7</numberFamilyMembers>
32. <sddFamilyMembers>3897</sddFamilyMembers>
33. <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">Информация_о_ЭЦП</ds:Signature>
34. </response>
35. ]]>
36. </data>
37. </responseData>
38. </response>
39. </return>
40. </ns2:getAddressSocialAssistanceResponse>
41. </soap:Body>
42. </soap:Envelope>
Обработка исключений
При обработке запроса методов getAddressSocialAssistance и getAddressSocialAssistanceUseToken может возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]
| Код/Текст ошибки/сообщения
|
Описание ошибки/сообщения
|
Примечание
|
| SBF-VE-8
|
Номер "ИИН" должен содержать 12 цифр
|
|
| VAL-JSR-001
|
Обязательное поле "%s" отсутствует
|
|
| SBF-AD-1
|
Пользователь «%s» не имеет прав для выполнения действия
|
|
|
|
Обязательное поле UserId отсутствует
|
|
| FAULT-015
|
Сервис на стороне ГБД не доступен
|
|
| IIN NOT FOUND
|
ИИН не найден
|
|
| SIGNATURE_NOT_VALID
|
Отсутствует ЭЦП или ЭЦП не валидна
|
|
| ACCESS_DENIED
|
Доступ запрещен
|
|