Andmevahetussüsteemi X-tee liides: Difference between revisions
Line 23: | Line 23: | ||
= Teenused = | = Teenused = | ||
== ''' | == '''getSubjectPositiveData''' == | ||
Krediiditaotleja andmete pärimine Osalejate andmekogudest. | Krediiditaotleja andmete pärimine Osalejate andmekogudest. | ||
Line 37: | Line 38: | ||
== ''' | == '''addSubjectPositiveData''' == | ||
Ühe tarbijakrediidi andmete registreerimine. | Ühe tarbijakrediidi andmete registreerimine. | ||
Line 51: | Line 52: | ||
== ''' | == '''updateSubjectPositiveData''' == | ||
Ühe tarbijakrediidi andmete uuendamine. | Ühe tarbijakrediidi andmete uuendamine. | ||
Line 64: | Line 65: | ||
== ''' | == '''deleteSubjectPositiveData''' == | ||
Ühe tarbijakrediidi andmete kustutamine. | Ühe tarbijakrediidi andmete kustutamine. | ||
Line 77: | Line 78: | ||
== ''' | == '''uploadPositiveDataMtom''' == | ||
Kõigi kehtivate tarbijakrediitide andmete sisseimportimine. | Kõigi kehtivate tarbijakrediitide andmete sisseimportimine. | ||
Line 153: | Line 154: | ||
[[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]] | [[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]] | ||
== ''' | == '''uploadPositiveDataStatus''' == | ||
Üleslaetud kõigi kehtivate tarbijakrediitide andmete alusel tekitatud faili töötlemise staatuse pärimine. | Üleslaetud kõigi kehtivate tarbijakrediitide andmete alusel tekitatud faili töötlemise staatuse pärimine. | ||
Revision as of 15:22, 4 August 2016
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
- sisendandmed - teenuse rakendamiseks vajalikud andmed
Vastuse keha
- väljundandmed - teenuse rakendamise tulemusena saadud andmed
Teenused
getSubjectPositiveData
Krediiditaotleja andmete pärimine Osalejate andmekogudest.
Päringu sõnum
Vastuse sõnum
addSubjectPositiveData
Ühe tarbijakrediidi andmete registreerimine.
Päringu sõnum
Vastuse sõnum
updateSubjectPositiveData
Ühe tarbijakrediidi andmete uuendamine.
Päringu sõnum
Vastuse sõnum
deleteSubjectPositiveData
Ühe tarbijakrediidi andmete kustutamine.
Päringu sõnum
Vastuse sõnum
uploadPositiveDataMtom
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. Sõnumi teises osas on gzip-ga kokkupakkitud ja seejärel base64-ga kodeeritud tarbijakrediitide andmetega xml, mis vastab skeemile http://www.krediidiinfo.ee/schemas/positive_register/data_exchange.xsd.
SOAP ümbriku parameetrid on:
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
uploadPositiveDataStatus
Üleslaetud kõigi kehtivate tarbijakrediitide andmete alusel tekitatud faili töötlemise staatuse pärimine.
Päringu sõnum
Vastuse sõnum
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. |