KiDocExchange
Jump to navigation
Jump to search
Tutvustus
KiDocExchange on Krediidiinfo veebiteenus failide saatmiseks Krediidiinfosse.
WSDL
KiDocExchange veebiteenuse WSDL fail on aadressil http://services.krediidiinfo.ee/KiDocExchange.wsdl.
Järgnevusdiagramm
Järgnevusdiagrammil on näidatud KiDocExchange meetodite väljakutsumise järjekorrad.
Meetodid
startUpload
Failide üleslaadimise initsialiseerimine.
| Nimi | Tüüp | Kirjeldus | |
|---|---|---|---|
| Sisendparameeter: | fileName | xs:string | Faili nimi |
| Väljundparameeter: | docID | xs:integer | Unikaalne faili id Krediidiinfo serveris. |
uploadChunk
Laetakse serverisse ning lisatakse juba serveris olevale failile lõppu osa failist. Kliendid võivad kogu faili saata ka ühe osana. Failide jupitamist on soovitav kasutada desktop lahendustes suurte failide saatmisel.
| Nimi | Tüüp | Kirjeldus | |
|---|---|---|---|
| Sisendparameetrid: | docID | xs:integer | Faili identifikaator. |
| chunk | xs:base64Binary | Järgmine faili osa. | |
| Väljundparameeter: | None |
finishUpload
Faili üleslaadimise lõpetamine.
| Nimi | Tüüp | Kirjeldus | |
|---|---|---|---|
| Sisendparameetrid: | docID | xs:integer | Faili identifikaator |
| md5 | xs:string | Üles laetud faili MD5 kontrollsumma. | |
| Väljundparameeter: | errorCode | xs:integer | Kui 0, siis faili üleslaadimine õnnestus. Kui negatiivne, siis tekkis mingi viga (vt veakoodide). |
getStatusCode
Tagastatakse üles laetud faili staatus serveris.
| Nimi | Tüüp | Kirjeldus | ||
|---|---|---|---|---|
| Sisendparameeter: | docID | xs:integer | Faili identifikaator | |
| Output Parameters: | status_code | xs:integer | Faili staatuse kood: | |
| 0 | Fail on töödeldud | |||
| 2 | Toimub faili üles laadimine | |||
| 3 | Toimub faili töötlemine | |||
| 4 | Fail on edukalt üles laetud ning ootab töötlemist | |||
| -1 | Tundmatu viga. Täpsema info saamiseks võtke ühendust tehnilise teoga. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg. | |||
| -10003 | MD5 kontroll ebaõnnestus. Kliendi saadetud MD5 kontrollsumma ei langenud kokku serveri poolt arvutatud MD5 kontrollsummaga. | |||
| -xxxxx | Faili töötlemine ebaõnnestus. Täpsema info saamiseks võta ühendust tehnilise toega. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg. | |||
getStatusMsg
Tagastatakse staatust täpsustav info.
| Nimi | Tüüp | Kirjeldus | |
|---|---|---|---|
| Sisendparameeter: | docID | xs:integer | Faili identifikaator |
| Väljundparameeter: | statusMsg | xs:string | Faili staatust täpsustav info |
Veakoodid
| Kood | Kirjeldus |
| 0 | Success |
| Päringu töötlus õnnestus. | |
| -10001 | Access denied |
| Üritatakse pöörduda faili poole, mis kuulub kellelegi teisele. | |
| -10002 | File does not exists |
| Kasutati faili identifikaatorit, mida ei eksisteeri. | |
| -10003 | MD5 failure |
| Kliendi saadetud MD5 ei lange kokku serveri poolt arvutatud MD5-ga |