KiCreditRiskManagement en

From services.krediidiinfo.ee
Revision as of 13:50, 12 June 2013 by Kart (talk | contribs)
Jump to navigation Jump to search
Flag of Estonia.svg eesti keeles


Introduction

KiCreditRiskManagement is the name of a Credit Risk Management Web Service based on SOAP protocol. The service - http://www.krediidiinfo.ee/index.php?m=49

WSDL

KiCreditRiskManagement WSDL is located at http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl.


Methods

start

Adding company into Credit Risk Management.


Name Type Description
Input parameter: regCode xs:string Company’s registry code.
Output parameter: resultCode xs:int The value is 0, if the request succeeds. If the value is negative, then it is an error code. Possible values of error codes.


end

Ettevõtte krediidiriskide jälgimise lõpetamine.


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 siin.


getCreditRiskData

Ettevõtte krediidiriskide põhiandmete ja sündmuste pärimine.


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. Vaata näidisfaili: KiCreditRiskManagement__getCreditRiskData.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!

getEvents

Etteantud ajavahemikus toimunud sündmuste pärimine.


Nimi Tüüp Kirjeldus
Sisendparameetrid: begin xs:date Alguskuupäev (ka), millest alates toimunud sündmusi soovitakse pärida.
end xs:date Lõpukuupäev (ka), milleni toimunud sündmusi soovitakse pärida.
Väljundparameeter: xml xs:string vastus XML formaadis. XML skeem asub aadressil http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd. Vaata näidisfaili: KiCreditRiskManagement__getEvents.xml. Kui päritav ettevõte ei ole krediidiriskide jälgimise all, siis a) kui ettevõte on krediidijärelvalves, siis päringu tulemuseks saadav XML-is on krediidijälvalve sündmused b) kui ettevõte ei ole krediidijärelvalves, siis märgendi event sisu tühi.

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.

-20404 LONG_PERIOD

Liiga pikk ajavahemik, milles registreeritud andmeid soovitakse pärida.


Arendamine

Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:

  • Autentimise meetod: Basic Authentication
  • Kasutajanimi: 30546
  • Parool: soapdemo



Näide PHP-s

<?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!";
}


$xml = $client->getCreditRiskData($regCode);
echo $xml;


$resultCode = $client->end($regCode);
if ($resultCode == 0) {
    echo "Ettevõte krediidiriskide jälgimine on lõpetatud!";
}


$xml = $client->getEvents('2013-01-01', '2013-01-07');
echo $xml;
?>