В статье описывается принцип работы сервиса по получению сведений о лицах, воспитывающих ребенка-инвалида (детей-инвалидов) (далее - Сервис) посредством информационной системы АО «Государственное кредитное бюро» (далее - ГКБ), методы запроса данных, примеры входных и выходных SOAP-запро¬сов, возможные ошибки.
Описание сервиса PersonRaisingDisabledChildsImplService
При вызове веб-сервиса обязательно указываются следующие параметры:
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:getPersonRaisingDisabledChilds/>
7. </soapenv:Body>
8. </soapenv:Envelope>
где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 - есть значение HTTP Header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм Basic Authentication.
Метод getPersonRaisingDisabledChilds
Метод getPersonRaisingDisabledChilds сервиса PersonRaisingDisabledChildsImplService предназначен для получения сведений о лицах, воспитывающих ребенка-инвалида (детей-инвалидов).
Таблица 1. Состав данных запроса на получение информации [Показать ответ]
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| 1
|
ИИН субъекта
|
iin
|
xs:string
|
Да
|
Значение должно содержать 12 цифр
|
| 2
|
Номер запроса
|
requestNumber
|
xs:string
|
Да
|
Значение поля должно быть уникальным и не должно повторяться при каждом запросе
|
| 3
|
Согласие субъекта на запрос данных
|
consentConfirmed
|
xs:boolean
|
Да
|
Возможные значения:
- true;
- false.
|
Таблица 2. Состав данных ответа на запрос получения информации [Показать ответ]
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| 1
|
Ответ на запрос
|
response
|
SyncsendMessageResponse
|
Да
|
|
| 2
|
Метаданные ответа
|
responseInfo
|
SyncsendMessageResponse
|
Да
|
|
| 3
|
Идентификатор сообщения в системе получателя
|
responseInfo/essageId
|
xs:string
|
Да
|
|
| 4
|
Идентификатор цепочки сообщения в системе получателя запроса
|
responseInfo/correlationId
|
xs:string
|
Нет
|
|
| 5
|
Дата ответа в системе получателя запроса
|
responseInfo/responseDate
|
xs:dateTime
|
Да
|
|
| 6
|
Объект «Информация о статусе»
|
responseInfo/status
|
StatusInfo
|
Да
|
|
| 6.1
|
Код статуса
|
status/code
|
xs:string
|
Да
|
|
| 6.2
|
Сообщение о статусе
|
status/message
|
xs:string
|
Да
|
|
| 7
|
Объект «Данные ответа»
|
responseData
|
DataInfo
|
Да
|
|
| 8
|
Объект «Данные сообщения»
|
data
|
xs:Anytype
|
Нет
|
|
| №
|
Наименование
|
Поле
|
Формат
|
Обязательность
|
Примечание
|
| Возвращаемая информация по лицам, воспитывающим ребенка-инвалида (детей-инвалидов)
(response)
|
| 1
|
ИИН субъекта
|
iin
|
xs:string
|
Да
|
|
| 2
|
Фамилия субъекта
|
surname
|
xs:string
|
Да
|
|
| 3
|
Имя субъекта
|
firstname
|
xs:string
|
Да
|
|
| 4
|
Отчество субъекта
|
secondname
|
xs:string
|
Нет
|
|
| 5
|
Пол субъекта
|
sex
|
xs:string
|
Да
|
Возможные значения:
1 – мужской;
0 – женский.
|
| 6
|
Дата рождения субъекта
|
birthday
|
xs:date
|
Да
|
Формат:
YYYY-MM-DD
|
| Блок информации по выплатам*
(queue)
|
| 7
|
Дата назначения (начала) выплаты
|
queue/firstPaymentdate
|
xs:date
|
Да
|
Формат:
YYYY-MM-DD
|
| 8
|
Дата окончания выплаты
|
queue/lastPaymentdate
|
xs:date
|
Да
|
Формат:
YYYY-MM-DD
|
- - при наличии нескольких выплат у физического лица, данные передаются в массиве
Пример вызова метода getPersonRaisingDisabledChilds
Пример вызова метода getPersonSocialStatus сервиса с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.mtszn.scb.kz/">
2. <soapenv:Header>
3. <userId>USER_ID</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getPersonRaisingDisabledChilds>
7. <iin>ИИН_СУБЪЕКТА</iin>
8. <requestNumber>НОМЕР_ЗАПРОСА</requestNumber>
9. <consentConfirmed>true</consentConfirmed>
10. </data:getPersonRaisingDisabledChilds>
11. </soapenv:Body>
12. </soapenv:Envelope>
Пример ответа на вызов метода getPersonRaisingDisabledChilds
Пример ответа на вызов метода getPersonRaisingDisabledChilds сервиса с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getPersonRaisingDisabledChildsResponse xmlns:ns2="http://data.mtszn.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <response>
6. <responseInfo>
7. <messageId>e431a71c-0378-4c85-a5ce-42b3c0e401c1</messageId>
8. <correlationId>56662d82-5b3c-42f9-afb6-ee7a72ac6b18</correlationId>
9. <responseDate>2021-03-30T13:48:28.202+06:00</responseDate>
10. <status>
11. <code>0</code>
12. <message>OK</message>
13. </status>
14. <sessionId>{6d5ca9ee-5620-4af1-85a1-c4c22c44ff11}</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[
19. <?xml version="1.0" encoding="UTF-8" standalone="no"?>
20. <response>
21. <iin>ИИН_СУБЪЕКТА</iin>
22. <surname>ФАМИЛИЯ</surname>
23. <firstname>ИМЯ</firstname>
24. <secondname>ОТЧЕСТВО</secondname>
25. <sex>0</sex>
26. <birthday>1976-06-21</birthday>
27. <queue>
28. <firstPaymentdate>2020-01-01</firstPaymentdate>
29. <lastPaymentdate>2022-12-31</lastPaymentdate>
30. </queue>
31. <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
32. <ds:SignedInfo>
33. <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
34. <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34310-gost34311"/>
35. <ds:Reference URI="">
36. <ds:Transforms>
37. <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
38. <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"/>
39. </ds:Transforms>
40. <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#gost34311"/>
41. <ds:DigestValue>GkTLdV7Fe2DIStNVJd5RzCFvjq863mTJA2R+ajSljcE=</ds:DigestValue>
42. </ds:Reference>
43. </ds:SignedInfo>
44. <ds:SignatureValue>dSpAQ2...EzQ==</ds:SignatureValue>
45. <ds:KeyInfo>
46. <ds:X509Data>
47. <ds:X509Certificate>MIIE...tSMG</ds:X509Certificate>
48. </ds:X509Data>
49. </ds:KeyInfo>
50. </ds:Signature>
51. </response>
52. ]]>
53. </data>
54. </responseData>
55. </response>
56. </return>
57. </ns2:getPersonRaisingDisabledChildsResponse>
58. </soap:Body>
59. </soap:Envelope>
Обработка исключений метода getPersonRaisingDisabledChilds
При обработке запроса метод getPersonRaisingDisabledChilds сервиса может возвращать следующие виды ошибок/исключений/сообщений: [Показать ответ]
| Код/Текст ошибки/сообщения
|
Описание ошибки/сообщения
|
Примечание
|
| SBF-VE-8
|
Номер "ИИН" должен содержать 12 цифр
|
|
| VAL-JSR-001
|
Обязательное поле "%s" отсутствует
|
|
| ScbSystemFault
|
Пользователь «%s» не имеет прав для выполнения действия
|
|
| FAULT-015
|
Сервис на стороне ГБД не доступен
|
|
| VAL-R-004
|
Для получения отчета необходимо подтвердить согласие субъекта на запрос его данных из ГБД
|
|