Andmevahetussüsteemi X-tee liides

From services.krediidiinfo.ee
Jump to navigation Jump to search

Tutvustus

KRI6 on Krediidiinfo liides, mille vahendusel Osalejad vahetavad krediiditaotleja krediidikohustuste andmeid omavahel X-tee versioon 6 vahendusel. See spetsifikatsioon kirjeldab andmete vahetuse tehnilisi aspekte. KRI6 teenuste kasutamine eeldab, et osaleja on liitunud X-teega.

WSDL

KRI6 WSDL asub aadresslil https://services.krediidiinfo.ee/wsdl/kri6.wsdl.

X-tee sõnum

X-tee päringu ja vastuse sõnumid on SOAP ümbrikud, mis koosnevad päisest ja kehast. Päises oleva info koosseis on määratud X-tee spetsifikatsiooni poolt. Kehas oleva info koosseis on määratud käesoleva dokumendi poolt.

X-tee sõnumi keha

Päringu keha

  • teenus - rakendatava teenuse nimi. Teenuste nimekiri kirjeldatud allpool ja wsdl-s.
  • sisendandmed - xml teenuse rakendamiseks vajalike andmetega. XML-i struktuur kirjeldatud allpool ja wsdl-s.

Vastuse keha

  • väljundandmed - teenuse rakendamise tulemusena saadud andmed XML kujul. XML-i struktuur kirjeldatud allpool ja wsdl-s.


Teenused

kri6.getSubjectPositiveData.v1

Krediiditaotleja andmete pärimine Osalejate andmekogudest.

Päringu sõnum

GetSubjectPositiveData


Vastuse sõnum

GetSubjectPositiveDataResponse


kri6.addSubjectPositiveData.v1

Ühe tarbijakrediidi andmete registreerimine.

Päringu sõnum

AddSubjectPositiveData


Vastuse sõnum

AddSubjectPositiveDataResponse


kri6.updateSubjectPositiveData.v1

Ühe tarbijakrediidi andmete uuendamine.

Päringu sõnum

UpdateSubjectPositiveData


Vastuse sõnum

UpdateSubjectPositiveDataResponse


kri6.deleteSubjectPositiveData.v1

Ühe tarbijakrediidi andmete kustutamine.

Päringu sõnum

DeleteSubjectPositiveData


Vastuse sõnum

DeleteSubjectPositiveDataResponse


kri6.uploadPositiveDataMtom.v1

Kõigi kehtivate tarbijakrediitide andmete sisseimportimine.

Päringu sõnum

Päringu sõnum on MTOM/XOP formaadis, mis vastab SOAP multipart/related standardile. Sõnumi esimeses osas on SOAP ümbrik ja teises osas asuvad gzip-ga kokkupakkitud ja seejärel base64-ga kodeeritud tarbijakrediitide andmed.


SOAP ümbriku parameetrid on:

UploadPositiveDataMtom

Näitepäring:

...Teised päised
Content-Type: multipart/related; type="application/xop+xml"; start="<xxx>"; start-info="text/xml"; boundary="MIME_boundary"'
MIME-Version: 1.0

--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <xxx>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="urn:kri6"
    xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
    xmlns:id="http://x-road.eu/xsd/identifiers"
    xmlns:inc="http://www.w3.org/2004/08/xop/include">
<SOAP-ENV:Header>
    <xrd:client id:objectType="MEMBER">
        <id:xRoadInstance>EE</id:xRoadInstance>
        <id:memberClass>XX</id:memberClass>
        <id:memberCode>00000000</id:memberCode>
    </xrd:client>
    <xrd:service id:objectType="SERVICE">
        <id:xRoadInstance>EE</id:xRoadInstance>
        <id:memberClass>XX</id:memberClass>
        <id:memberCode>10256137</id:memberCode>
        <id:serviceCode>uploadPositiveDataMtom</id:serviceCode>
        <id:serviceVersion>v1</id:serviceVersion>
    </xrd:service>
    <xrd:id>4894e35d-bf0f-44a6-867a-8e51f1daa7e0</xrd:id>
    <xrd:userId>EE00000000000</xrd:userId>
    <xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
    <ns1:uploadPositiveDataMtom>
        <positive_data>
            <inc:Include href="cid:xxx"/>
        </positive_data>
    </ns1:uploadPositiveDataMtom>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

--MIME_boundary
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64
Content-ID: <xxx>
Content-Disposition: attachment; filename="pos_data.xml.gz"

ZZZ

--MIME_boundary--

Vastuse sõnum

UploadPositiveDataMtomResponse

kri6.uploadPositiveDataStatus.v1

Üleslaetud kõigi kehtivate tarbijakrediitide andmete alusel tekitatud faili töötlemise staatuse pärimine.

Päringu sõnum

UploadPositiveDataStatus


Vastuse sõnum

UploadPositiveDataMtomResponse

Veakoodid

X Request failed
Päringu tegemine ebaõnnestus
X Access denied
Puudub liigipääs süsteemile
X Partial members
Päring sisaldab mitte kõiki Osalejate Andmekogudest Andmeid. Veakirjelduses on toodud Osalejate arv, kelle andmekogudest Andmete pärimine ebaõnnestus.