services.krediidiinfo.ee - User contributions [en]

X-Tee

2018-11-23T12:47:10Z

Vlads:

=Sissejuhatus=
Majutatud turvaserveri kasutamine sobib klientidele, kellel on oma infosüsteem ja selle haldamise võimekus, aga puudub vajadus või võimekus hallata X-tee turvaserverit. Majutatud turvaserver annab kliendile võimalust kasutada andmekogude (teenuse pakkujate) teenuseid X-tee kaudu.

=Terminid=
'''Andmekogu''' -X-tee liikme alamsüsteem, mis pakub X-teel teenuseid

'''Andmeteenus''' - X-tee liikme poolt defineeritud ja realiseeritud teenus, mille kaudu saab teiste X-tee liikmetega andmeid vahetada.

'''X-tee alamsüsteem''' - tehnoloogiliselt ja organisatoorselt piiritletud X-tee liikme infosüsteemi osa andmeteenuse osutamiseks või kasutamiseks. X-tee alamsüsteemidena registreeritakse X-tee liikme infosüsteemi ja turvaserveri liidestuskohad, mida on võimalik andmeteenuse osutaja või kasutajana kindlaks määrata.

=Osapooled=
'''Klient''' - X-tee liige, kes tarbib teenuse osutaja poolt loodud teenust. Selleks sõlmib ta teenuse osutajaga kokkuleppe.

'''Teenuse pakkuja (osutaja)''' - X-tee liige, kes defineerib, realiseerib ja kirjeldab RIHAs enda teenuse. Teenuse tarbija sõlmib osutaja poolt loodud teenuse tarbimiseks kokkuleppe.

'''Creditinfo''' - X-tee liige, kes on ka andmeteenuse vahendaja, kes pakub teenusena turvaserveri majutust ja haldust. See tähendab, et teenuse osutaja ja kasutaja vaheline andmeliiklus läbib tema kontrolli all olevat infrastruktuuri. Andmeteenuse vahendaja kasutamisel tuleb kokku leppida teenuse vahendamise poliitika.

=Andmeteenuse kasutamise protsessi skeem=

[[File:xroad_requests.PNG]]

=Ettevalmistusprotsess andmeteenuse kasutamiseks=
[[File:Ettevalmistustegevused X-tee turvaserveri majutamiseks.jpg|1030x1030px]]

==Kliendi ja Creditinfo vahel vahetatavate andmete koosseis==

===Teenuse tarbija andmed===

*Asutuse registrikood
*Alamsüsteemi nimi
*Teenuse kasutaja isikukood

===Teenuse pakkuja (X-tee keskuses registreeritud) andmed===

*Teenuse pakkuja andmekogu nimi
*Teenuse nimi
*Teenuse versioon
*Teenus on X-tee test- või toodangkeskkonnas
*Tenuse sisendparameetrid x-tee testkeskkonnas

=Juhendid=

[https://www.ria.ee/ee/x-tee-liitumine.html RIA X-Teega liitumise juhend]

==Andmeteenuse tarbija registreerimine RIHA's==

Eeldus: ettevõtte registreerimiseks RIHA's vajalik Eesti Äriregistris registreeritud ettevõte.

RIHA koduleht https://riha.eesti.ee/

[https://moodle.ria.ee/course/view.php?id=3 Asutuse registreerimise juhend]

[https://moodle.ria.ee/mod/page/view.php?id=79 Alamsüsteemi registreerimise juhend]

Liitumistaotlus vaadatakse läbi paari-kolme tööpäeva jooksul ning otsus saadetakse liitumistaotluse esitanud isikule taotlusel näidatud e-posti aadressile.

==Turvalise allkirjastamise mooduli (HSM) sertifikaatide hankimine==

*Testkeskkonna sertifikaate tellides vajad Creditinfolt testkeskonna jaoks mõeldud CSR-faili , minge lehele https://sk.ee/teenused/digitempli-teenus/ , valige Telli e-tempel ning lisa "linnuke" kasti "Tellin testsertifikaadi". Edasi tuleb täita kõik kohustuslikud väljad. Seal küsitakse küll HSM-i kohta infot, aga sinna võib kirjutada "HSM/turvamoodul vms", keegi seda ei kontrolli. Allkirjastada võib ükskõik kes, kuna tegemist on testiga.
*Toodangukeskkonna sertifikaadi tellimiseks minge Sertifitseerimiskeskuse kodulehele https://sk.ee/teenused/teenused-x-tee-liikmele/ ja valige „Telli turvaserveri kliendina“. Toodangukeskkonna jaoks sertifikaati tellides on vaja Creditinfolt samuti selleks mõeldud CSR-faili, lisaks infot HSM-i kohta:

Krüptograafilise mooduli/seadme nimi: Luna PCI-E Cryptographic Module for Luna SA

Seerianumber: 1507267162

Firmware versioon: 6.10.9

ja FIBS sertifikaati, mille saadab Creditinfo.

*Saatke ostetud sertifikaadid Creditinfole, kes paigaldab sertifikaadid allkirjastamise turvamoodulisse (HSM)

==Klient sõlmib lepingu vajaliku andmebaasi haldajaga==

*Rahvastikuregister - https://www.smit.ee/rahvastikuregister

*Pensioniregister (haldaja Eesti väärtpaberikeskus) - https://www.e-register.ee/

File:Xroad requests.PNG

2018-11-23T12:46:04Z

Vlads:

Vlads: /* Meetodid */

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCreditManagement__en|In English]]
|}

= Tutvustus =

KiCreditRiskManagement on Krediidiinfo SOAP protokollil põhinev krediiriskide halduse veebiteenus.

= WSDL =

KiCreditRiskManagement WSDL asub aadresslil [http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl].

= Meetodid =

== ''start'' ==

Ettevõtte lisamine krediidiriskide jälgimise alla.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| resultCode
| xs:int
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin].
|}

== ''end'' ==

Ettevõtte krediidiriskide jälgimise lõpetamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| resultCode
| xs:int
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin].
|}

== ''getCreditRiskData'' ==

Ettevõtte krediidiriskide põhiandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| xml
| xs:string
| vastus XML formaadis. XML skeem asub aadressil [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd]. Vaata näidisfaili: [[KiCreditRiskManagement__getCreditRiskData_example.xml]]. Kui päritav ettevõte ei ole krediidiriskide jälgimise all, siis on päringu tulemuseks saadav XML-is märgendi ''company'' sisu tühi (vt [[KiCreditRiskManagement__getCreditRiskData_example.xml|näidist]])!
|}

= Veakoodid =

== -20400 UNKNOWN ==

Tundmatu viga

== -20401 INVALID_REGCODE ==

Vigane ettevõtte registrikood

== -20402 SERVICE_ALREADY_ACTIVE ==

Ettevõte on juba krediidiriskide jälgimise all.

== -20403 SERVICE_INACTIVE ==

Ettevõte ei ole krediidiriskide jälgimise all.

= Arendamine =

Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:

* Autentimise meetod: ''Basic Authentication''
* Kasutajanimi: ''30546''
* Parool: ''soapdemo''

= Näide PHP-s =

<pre>
<?php
/**
* Example of using Krediidiinfo AS SOAP interface KiCreditRiskManagement.
*
* In this example the demo username and password is used so there is no need
* to contact with Krediidiinfo AS in order to run this program.
*
* @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement
* @author Julia Parkkonen <julia.parkkonen@krediidiinfo.ee>
* @created 04.06.2013
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl';
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement'
, 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?).
, 'password' => 'soapdemo' // <-- password
);

$client = new SoapClient($wsdl_url, $params);

$regCode = '10256137';
$resultCode = $client->start($regCode);
if ($resultCode == 0) {
echo "Ettevõte lisatud krediidiriskide jälgimise alla!";
}

?>

</pre>

KiCreditRiskManagement

2013-06-04T13:13:54Z

Vlads: /* start */

KiCreditRiskManagement

2013-06-04T13:12:21Z

Vlads: Created page with "{| align="right" | 30px In English |} = Tutvustus = KiCreditRiskManagement on Krediidiinfo SOAP ..."

Main Page

2013-06-04T12:53:49Z

Vlads: /* Krediidiinfo veebiteenused */

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[Main page__en|In English]]
|}

Lehelt leiate Krediidiinfo veebiteenuste dokumentatsioonid ja näidised.

= Tutvustus =
* '''Mis on veebiteenus?'''
Veebiteenused (Web Service) on tarkvarakomponendid, mis asuvad serveris ning mille poole kliendiprogrammid pöörduvad üle interneti.

Veebiteenuse looja koostab koos veebiteenusega ka veebiteenuse dokumentatsiooni. Dokumentatsioonis on täpselt ära kirjeldatud veebiteenuse interneti aadress, mis andmevahetusprotokolle peab kasutama, millised on liidese meetodite nimed, millised on sisend- ja väljundparameetrite tüübid. Veebiteenuse kirjeldamiseks kasutatakse XML-põhist WSDL (Web Services Description Language) keelt.

Veebiteenused on sõltumatud kasutatavast platvormist. Veebiteenus võib ise töötada Linux operatsioonisüsteemiga serveris, kliendiprogramm seevastu Win32 operatsioonisüsteemiga lauaarvutis. Ühte veebiteenust on võimalik integreerida ükskõik millisesse arvutisse eeldusel, et on olemas internetiühendus.

Tänapäeval on kõrgtaseme tarkvaraarenduskeskkondadesse loodud tööriistad veebiteenuste lihtsaks integreerimiseks. WSDL kirjelduse põhjal suudavad arenduskeskkonnad genereerida programmeerija jaoks vajalikud teegid programmeerija poolt kasutatavas programmeerimiskeeles. Sisuliselt ei erine tarkvaraarendaja jaoks veebiteenuse väljakutsumine tavalisest funktsiooni väljakutsumisest. Kogu andmevahetuse ja tüübiteisenduste loogika on tarkvaraarendaja eest peidetud.

= Krediidiinfo veebiteenused =
* [[KiReport]]
* [[KiDocExchange]]
* [[KiCompanyBasic]]
* [[KiCompany]]
* [[KiCreditManagement]]
* [[KiCreditRiskManagement]]

= Arendajatele =
* [[Krediidiinfo veebiteenuste arhitektuur]]
* [[Autentimine]]
* [[Veebiteenuste silumine]]- Serveri testimine, raportite testimine testkeskkonnas
* [[Veatöötlus]]
* [[Veakoodid]]
* [[SOAP teenuse testimine]]
* [[Tehniline tugi]]
* Kasutatavad standardid/protokollid
** [http://www.w3schools.com/xml/default.asp XML]
** [http://www.w3schools.com/schema/default.asp XML Schema]
** [http://www.w3schools.com/soap/default.asp SOAP]
** [http://www.w3schools.com/wsdl/default.asp WSDL]

= Näidised =
* [[KiCompanyBasic | KiCompanyBasic - '''Tasuta liides!''']]

KiCompany

2013-05-31T10:40:24Z

Vlads: /* Meetodid */

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCompany__en|In English]]
|}

= Tutvustus =

KiCompany on SOAP protokollil põhinev Krediidiinfo AS veebiteenus ettevõtete, mittetulundusühingute ja riigiasutuste põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi [http://firmaparing.krediidiinfo.ee firmapäringu] funktsionaalsust.

= WSDL =

KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. See erineb varasemast WSDL-ist selle poolest, et ''RPC/encode'' asemel kasutatakse ''RPC/litteral''-i.

= Meetodid =

== getName ==

Ettevõtte nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri, ettevõtte äriregistrikood vigane vms), siis on väljundparameetri väärtuseks tühistring.
|}

== getRegistryName ==

Ettevõtte Äriregistri pika nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri), siis on väljundparameetri väärtuseks tühistring.
| Vigase registrikoodi korral tagastatakse viga -20501 (Invalid registry code value)
|}

== findCompanies ==

Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| 
| count
| xs:int
| Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla. (Meetod ei tagasta korraga rohkem kui 100 ettevõtet)
|-
| Väljundparameeter:
| companies
| ResultCompanyIDDataArray
| Indekseeritud massiiv, mille elementideks on ResultCompanyIDData tüüpi elemendid.
|}

ResultCompanyIDData on kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| name
| xs:string
| Ettevõtte nimi.
|}

== getBasicData ==

Ettevõtte põhiandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyBasicDataType
| Kirje ettevõtte andmetega.
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyBasicDataType tüüpi kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| ettevõtte äriregistri kood
|-
| name
| xs:string
| ettevõtte nimi.
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| legalStreet
| xs:string
| tänava nimi juriidilises aadressis
|-
| legalPostCode
| xs:string
| posti indeksi number juriidilises aadressis
|-
| legalCity
| xs:string
| linnanimi juriidilises aadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|-
| legalForm
| xs:string
| juriidiline vorm
|-
| shareCapital
| xs:int
| osakapitali suurus
|-
| shareCapitalCur
| xs:string
| valuuta tähis, milles on osakapitali suurus antud
|-
| regTime
| xs:string
| ettevõtte registreerimise aeg Äriregistris. Formaat: yyyy-mm-dd
|-
| regPlace
| xs:string
| registriosakonna nimetus kus ettevõte registreeriti
|-
| activities
| xs:string
| ettevõtte tegevusalade loetelu. Iga tegevusala ees on string '* ' (tärn ja tühik). Alates 29.07.2011 saab tegevusalade infot vaid erikokkuleppel. Kui kokkulepet pole, siis on väärtuseks tühistring.
|-
| status
| xs:string
| äriregistri staatuse nimetus
|-
|}

== getContactData ==

Ettevõtte kontaktandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyContactDataType
| kirje kontaktandmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyContactDataType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|}

== getLegalPostAddress ==

Ettevõtte juriidilise aadressi pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyPostAddressType
| kirje juriidilise aadressi andmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyPostAddressType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi
|-
| postCode
| xs:string
| indeks
|-
| city
| xs:string
| linn
|}

== isRegCodeValid ==

Ettevõtte äriregistri korrektsuse kontrollimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| Väljundparameeter:
| isValid
| xs:boolean
| Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige.
|}

== getVATNo ==

Ettevõtte käibemaksukohustuslase numbri pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| vatNo
| xs:string
| KMK number. Kui KMK number ei kehti või ettevõte ei ole käibemaksukohuslane, siis tagastatakse tühistring
|}

= Veakoodid =

== -10231 No company found! ==

Krediidiinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.

(vt lisaks [[Veakoodid|üldiseid veakoode]])

= Programmi näidis PHP-s =

Järgnevalt on toodud PHP-s kirjutatud KiCompany veebiteenuse kasutamise näide.

<pre>
<?php
/**
* Example of using KiCompany web service of Krediidiinfo AS
*
* @author Rait Kapp <rait@krediidiinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Krediidiinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$data = $client->getBasicData($regCode);
echo "Aadress: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
echo "Äriregistri kood {$regCode} on vigane.\n";
} else {
echo "Äriregistri kood {$regCode} on korrektne\n";
}

?>

</pre>

Programmi väljund:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Äriregistri kood 10256137 kuulub ettevõttele KREDIIDIINFO AS
Aadress: Narva mnt 5 10117 Tallinn
Äriregistri kood 10256136 on vigane.

</pre>

= HTTP päringute näidised =

Failis [http://services.krediidiinfo.ee/wiki/images/e/ed/KiCompany_request_examples.zip kiCompany_request_examples.zip] on KiCompany HTTP päringute ja päringu vastuste näidised. Kui KiCompany integreeritakse süsteemi saates otse HTTP päringuid, siis HTTP vastuse parsimisel kasutada XML vahendeid. Mitte käsitleda HTTP vastuseid kui stringe ja parsida neid nö käsitsi. Kui Krediidiinfo uuendab SOAP serveri tarkvara, siis võib vastuse sõnumi kuju muutuda.

2011-05-26T12:15:16Z

Vlads: Created page with "= Tutvustus = ''StudentLoanRegister'' on Krediidiinfo poolt loodud SOAP protokollil põhinev [http://services.krediidiinfo.ee/wiki/index.php/Krediidiinfo_veebiteenuste_arhitekt..."

= Tutvustus =

''StudentLoanRegister'' on Krediidiinfo poolt loodud SOAP protokollil põhinev [http://services.krediidiinfo.ee/wiki/index.php/Krediidiinfo_veebiteenuste_arhitektuur veebiteenus] Õppelaenuregistriga suhtlemiseks.

= WSDL =

''StudentLoanRegister'' WSDL asub aadresslil [http://services.krediidiinfo.ee/StudentLoanRegister.wsdl http://services.krediidiinfo.ee/StudentLoanRegister.wsdl].

= Meetodid =

== ''addPerson'' ==

Isiku lisamine õppelanuregistrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| personCode
| xs:string
| Isikukood
|-
| 
| personName
| xs:string
| Isiku nimi kujul eesnimi perekonnanimi. Maksimaalne pikkus 70 sümbolit.
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - Isiku lisamine õnnestus
|}

== ''removePerson'' ==

Isiku kustutamine õppelanuregistrist.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| personCode
| xs:string
| Isikukood
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - kustutamine õnnestus
|}

== ''changePersonName'' ==

Isiku nime muutmine registris

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| personCode
| xs:string
| Isikukood
|-
| 
| newPersonName
| xs:string
| Uus isiku nimi kujul eesnimi perekonnanimi. Maksimaalne pikkus 70 sümbolit.
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - muutmine õnnestus
|}

== ''addChildBonus'' ==

Lapse soodustuse määramine

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| parentPersonCode
| xs:string
| registris oleva lapsevanema isikukood
|-
| 
| childPersonCode
| xs:string
| lapse isikukood
|-
| 
| bonusBeginDate
| xs:date
| soodustuse alguskuupäev
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - soodustuse määramine õnnestus
|}

== ''removeChildBonus'' ==

Lapse soodustuse kustutamine

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| parentPersonCode
| xs:string
| Lapsevaname isikukood, kellel on lapse soodustus
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - soodustuse kustutamine õnnestus
|}

== ''reFinance'' ==

Õppelaenu refinantseerimine. Refinantseerimise algataja on laenu omanik, va juhul kui võetakse üle pankrotistunud panga laenu.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| personCode
| xs:string
| Isikukood
|-
| 
| bankCode
| xs:int
| Refinantseerija panga kood
|-
| Väljundparameeter::
| resultCode
| xs:int
| 0 - refinantseerimine õnnestus
|}

== ''getPersonData'' ==

/meetodi kirjeldus/

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| personCode
| xs:string
| /personCode kirjeldus/
|-
| Väljundparameeter::
| resultData
| xs:string
| Võlgniku andmed XML formaadis mis vastab XML Schemile [http://www.krediidiinfo.ee/schemas/student_loan_register/person_data.xsd http://www.krediidiinfo.ee/schemas/student_loan_register/person_data.xsd]
|}

/siia pilt http://www.krediidiinfo.ee/schemas/student_loan_register/data.xsd struktuurist (teha XML Spy-ga)/

= Väljundparameeter ''resultCode'' =

== 0 - päring õnnestus ==
== -20301 - viga isikukoodis ==
== -20302 - viga lapse isikukoodis ==
== -20303 - vale kasutajanimi või parool ==
== -20311 - isik on juba registris ==
== -20352 - päringu tegija pole õppelaenu omanik ==
== -20353 - isikut ei leitud registrist ==
== -20354 - refinantseerija panka ei leitud registrist või ta ei ole laenuandja ==
== -20357 - antud lapsega juba on soodustus ==
== -20358 - viga kuupäevas ==