В данной статье описывается принцип работы сервиса по "Передача данных по водному транспорту" посредством информационной системы АО «Государственное кредитное бюро» (далее - ГКБ), методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки.
Данный технический документ предназначается:
- 1) для разработчиков, которые будут осуществлять взаимодействие с информационной системой ГКБ;
- 2) для получателей информации.
Сервис по "Передача данных по водному транспорту"
При вызове веб-сервиса обязательно указываются следующие параметры:
- 1. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентификации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.
- 2. ID пользователя, от имени которого будет выполнена запрашиваемая операция в SOAP Header:
Http Headers: {Authorization=[Basic c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}
Состав данных запроса по методу getTbd
Состав данных запроса getTbd : [Показать ответ]
№
|
Наименование
|
Поле
|
Формат
|
Примечание
|
1
|
Индивидуальный идентификационный номер пользователя
|
userId
|
xs:string
|
|
2
|
Идентификационный номер владельца ИИН/БИН
|
iinBin
|
xs:string
|
|
3
|
Номер запроса
|
requestNumber
|
xs:string
|
|
4
|
Тип запроса
|
requestType
|
xs:string
|
INTERNATIONAL- Атрибутивный состав Выходной формы ГУ «Выдача разрешения на неоднократное пересечение Государственной границы Республики Казахстан казахстанскими судами для ведения промысловой деятельности в территориальных водах (море), внутренних водах и на континентальном шельфе»
INLAND- Атрибутивный состав Выходной формы ГУ «Выдача пропуска на выход в территориальные воды (море) и внутренние воды Республики Казахстан казахстанских маломерных самоходных и несамоходных (надводных и подводных) судов (средств) и средств передвижения по льду»
|
|
Состав данных ответа по методу getTbd
Состав данных ответа getTbd : [Показать ответ]
№
|
Наименование
|
Поле
|
Формат
|
Примечание
|
1
|
Возврат
|
return
|
xs:string
|
|
2
|
ответ
|
response
|
xs:string
|
|
3
|
Информация об ответе
|
responseInfo
|
SyncMessageInfoResponse
|
|
4
|
Идентификатор сообщения в системе получателя
|
messageId
|
xs:string
|
|
5
|
Сообщение о статусе
|
status
|
xs:string
|
|
6
|
Код статуса
|
code
|
xs:string
|
|
7
|
Сообщение
|
message
|
xs:string
|
|
8
|
Номер запроса
|
requestNumber
|
xs:string
|
|
9
|
Дата и время ответа
|
requestDate
|
xs:string
|
|
10
|
Информация о зарегестрированных судах
|
shipsData
|
xs:string
|
|
11
|
Информация о зарегестрированных судах
|
TShipsData
|
xs:string
|
|
12
|
Информация о судне
|
TInlandShipData
|
xs:string
|
InlandShipData- Информация о судне по услуге "Выдача пропуска на выход в территориальные воды (море) и внутренние воды Республики Казахстан казахстанских маломерных самоходных и несамоходных
(надводных подводных) судов (средств) и средств передвижения по льду"
InternationalShipData- Информация о судне по услуге "Выдача разрешения на неоднократное пересечение Государственной
границы Республики Казахстан казахстанскими судами для ведения промысловой деятельности в территориальных водах (море), внутренних водах и на континентальном шельфе"
|
13
|
Информация о судне
|
internationalShipData
|
xs:string
|
|
14
|
Наименование технического средства (Название судна)
|
shipName
|
xs:string
|
|
15
|
Бортовой номер (номер ИМО)
|
onboardNumber
|
xs:string
|
|
16
|
Тип плавсредства
|
shipType
|
xs:string
|
|
17
|
Регистрационный номер плавсредства (Номер судового билета или свидетельства)
|
certNumber
|
xs:string
|
|
18
|
Наименование собственника судна
|
shipOwnerName
|
xs:string
|
|
19
|
Адрес собственника судна
|
shipOwnerAddress
|
xs:string
|
|
20
|
Место приписки плавсредства (Порт приписки)
|
homePort
|
xs:string
|
|
21
|
ФИО капитана (владельца) судна
|
captainName
|
xs:string
|
|
22
|
Государственный регистрационный номер (Регистрационный номер судна)
|
stateRegNumber
|
xs:string
|
|
|
Пример вызова метода getTbd
Пример вызова метода getTbd с помощью 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>ххххххх-ххххххх-хххххх</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <data:getTbd>
7. <iinBin>ИИНБИН</iinBin>
8. <requestNumber>022222</requestNumber>
9. <requestType>INTERNATIONAL</requestType>
10. </data:getTbd>
11. </soapenv:Body>
12. </soapenv:Envelope>
Пример ответа на вызов метода getTbd
Пример ответа на вызов по методу getTbd с помощью SOAP запроса имеет следующий вид: [Показать ответ]
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <soap:Body>
3. <ns2:getTbdResponse xmlns:ns2="http://data.gbd.chdb.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">
4. <return>
5. <response>
6. <responseInfo>
7. <messageId>Идентификатор сообщения</messageId>
8. <correlationId/>
9. <responseDate>Дата ответа</responseDate>
10. <status>
11. <code>200</code>
12. <message>Message has been processed successfully</message>
13. </status>
14. <sessionId/>
15. </responseInfo>
16. <responseData>
17. <data xmlns:ns2="http://www.ktk.kz/knbws/v1">
18. <requestNumber>Номер запроса</requestNumber>
19. <requestDate>Дата запроса</requestDate>
20. <shipsData>
21. <internationalShipData>
22. <shipName>Са Джет 1</shipName>
23. <onboardNumber>9001679</onboardNumber>
24. <shipType>скоростной пассажирский катамаран</shipType>
25. <certNumber>244</certNumber>
26. <shipOwnerName>Наименование собственника судна</shipOwnerName>
27. <shipOwnerAddress>Адрес собственника судна</shipOwnerAddress>
28. </internationalShipData>
29. <internationalShipData>
30. <shipName>EVKLIDIS</shipName>
31. <onboardNumber>нет</onboardNumber>
32. <shipType>Понтон</shipType>
33. <certNumber>251</certNumber>
34. <shipOwnerName>Наименование собственника судна</shipOwnerName>
35. <shipOwnerAddress>Адрес собственника судна</shipOwnerAddress>
36. </internationalShipData>
37. <internationalShipData>
38. <shipName>ATLAS</shipName>
39. <onboardNumber>9186091</onboardNumber>
40. <shipType>Буксир</shipType>
41. <certNumber>310</certNumber>
42. </internationalShipData>
43. </shipsData>
44. </data>
45. </responseData>
46. </response>
47. <gbdStatusResponse xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
48. </return>
49. </ns2:getTbdResponse>
50. </soap:Body>
51. </soap:Envelope>
Обработка исключений метода getTbd
При обработке запроса метод getTbd может возвращать следующие виды ошибок: [Показать ответ]
Код ошибки
|
Описание ошибки
|
SBF-VE-8
|
Номер "ИИН/БИН" должен содержать 12 цифр
|
VAL-JSR-001
|
Обязательное поле "IINBIN" отсутствует
|
SBF-AD-1
|
Пользователь %s не имеет прав для выполнения действия
|
SBF-AD-1
|
Пользователь %s не активен
|
FAULT-015
|
Сервис на стороне ГБД недоступен
|
|