KiCreditManagement: Difference between revisions
Jump to navigation
Jump to search
(→Meetodid: meetodi sendProceedingInfo dokumentatsiooni lisamine) |
|||
Line 9: | Line 9: | ||
= Meetodid = | = Meetodid = | ||
== ''getOverview'' == | == ''getOverview'' == | ||
Line 24: | Line 26: | ||
| Kliendi kood kreeditori infosüsteemis. | | Kliendi kood kreeditori infosüsteemis. | ||
|- | |- | ||
| <b>Väljundparameeter | | <b>Väljundparameeter:</b> | ||
| xml | | xml | ||
| xs:string | | xs:string | ||
Line 31: | Line 33: | ||
== ''sendProceedingInfo'' == | |||
Kliendi kohta info edastamine krediidihaldusesse. | |||
{| style="border-style: solid; border-width: 1px;" | |||
! | |||
! Nimi | |||
! Tüüp | |||
! Kirjeldus | |||
|- | |||
| <b>Sisendparameetrid:</b> | |||
| clientCode | |||
| xs:string | |||
| Kliendi kood kreeditori infosüsteemis. | |||
|- | |||
| | |||
| text | |||
| xs:string | |||
| teate sisu vaba tekstina. | |||
|- | |||
| | |||
| type | |||
| xs:int | |||
| teate tüübi kood. Võimalikud väärtused: | |||
* 13 - kreeditori info, | |||
* 20 - inkasso info (mõeldud kreeditori inkasso partneritele). | |||
Kui Krediidiinfoga pole teisiti kokku lepitud, siis kasutada väärtuseks 13. | |||
|- | |||
| <b>Väljundparameeter:</b> | |||
| 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 (võib tulevikus juurde tulla): | |||
* -20201 - parameetrile ''clientCode'' vastavat klienti krediidihaldusest ei leitud. Kas kliendikood on vigane või siis ei ole kreeditor antud kliendi infot krediidihaldusesse saatnud. | |||
* -20202 - kasutatud parameetri ''type'' väärtust ei ole lubatud kasutada. | |||
)! | |||
|} | |||
= Arendamine = | = Arendamine = |
Revision as of 15:11, 27 July 2010
Tutvustus
KiCreditManagement on Krediidiinfo SOAP protokollil põhinev krediidihalduse veebiteenus.
WSDL
KiCreditManagement WSDL asub aadresslil http://services.krediidiinfo.ee/KiCreditManagement.wsdl.
Meetodid
getOverview
Kliendi kohta krediidihalduri krediidihinnangu ja krediidijärelvalve ajaloo pärimine.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | clientCode | xs:string | Kliendi kood kreeditori infosüsteemis. |
Väljundparameeter: | xml | xs:string | vastus XML formaadis. XML skeem asub aadressil http://www.krediidiinfo.ee/schemas/kh/debtor_cmdata.xsd. Vaata näidisfaili: debtor_cmdata_example.xml. Kui päritavat klienti ei ole krediidihalduse andmebaasis, siis on päringu tulemuseks saadav XML-is märgendi debtor sisu tühi (vt näidist)! |
sendProceedingInfo
Kliendi kohta info edastamine krediidihaldusesse.
Nimi | Tüüp | Kirjeldus | |
---|---|---|---|
Sisendparameetrid: | clientCode | xs:string | Kliendi kood kreeditori infosüsteemis. |
text | xs:string | teate sisu vaba tekstina. | |
type | xs:int | teate tüübi kood. Võimalikud väärtused:
Kui Krediidiinfoga pole teisiti kokku lepitud, siis kasutada väärtuseks 13. | |
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 (võib tulevikus juurde tulla):
)! |
Arendamine
Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:
- Autentimise meetod: Basic Authentication
- Kasutajanimi: 30546
- Parool: soapdemo
Näidiskasutaja korral saab meetodi getOverview parameetril clientCode olla vaid kolm järgmist väärtust:
- full - tagastatakse näidis-XML, kus on täidetud kõik märgendid
- minimal - tagastatakse näidis-XML, kus on täidetud minimaalsed väljad.
- none - tagastatakse tühi XML, mis tagastatakse juhul, kui päritav klient ei ole Krediidiinfo krediidihalduse andmebaasis.