KiCompany: Difference between revisions
Jump to navigation
Jump to search
m (tühikud peatükkide vahele) |
|||
| Line 2: | Line 2: | ||
KiCompany on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi [http://firmaparing.krediidiinfo.ee firmapäringu] funktsionaalsust. | KiCompany on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi [http://firmaparing.krediidiinfo.ee firmapäringu] funktsionaalsust. | ||
= WSDL = | = WSDL = | ||
KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl]. | KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl]. | ||
= Meetodid = | = Meetodid = | ||
== getName == | == getName == | ||
| Line 29: | Line 35: | ||
| 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. | | 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. | ||
|} | |} | ||
== findCompanies == | == findCompanies == | ||
| Line 72: | Line 80: | ||
| Ettevõtte nimi. | | Ettevõtte nimi. | ||
|} | |} | ||
== getBasicData == | == getBasicData == | ||
| Line 180: | Line 190: | ||
|- | |- | ||
|} | |} | ||
== getContactData == | == getContactData == | ||
| Line 239: | Line 251: | ||
| e-posti aadressid | | e-posti aadressid | ||
|} | |} | ||
== getLegalPostAddress == | == getLegalPostAddress == | ||
| Line 282: | Line 296: | ||
| linn | | linn | ||
|} | |} | ||
== isRegCodeValid == | == isRegCodeValid == | ||
| Line 303: | Line 319: | ||
| Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige. | | Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige. | ||
|} | |} | ||
= Veakoodid = | = Veakoodid = | ||
== -10231 No company found! == | == -10231 No company found! == | ||
Revision as of 09:35, 10 January 2008
Tutvustus
KiCompany on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi firmapäringu funktsionaalsust.
WSDL
KiCompany WSDL asub aadressil http://services.krediidiinfo.ee/KiCompany.wsdl.
Meetodid
getName
Ettevõtte nime pärimine.
| 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. |
findCompanies
Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.
| 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:
| Nimi | Tüüp | Kirjeldus | |
|---|---|---|---|
| regCode | xs:string | Ettevõtte äriregistri kood | |
| name | xs:string | Ettevõtte nimi. |
getBasicData
Ettevõtte põhiandmete pärimine.
| 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:
| 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). |
| status | xs:string | äriregistri staatuse nimetus |
getContactData
Ettevõtte kontaktandmete pärimine.
| 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:
| 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.
| 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:
| Nimi | Tüüp | Kirjeldus |
|---|---|---|
| street | xs:string | tänava nimi |
| postCode | xs:string | indeks |
| city | xs:string | linn |
isRegCodeValid
Ettevõtte äriregistri korrektsuse kontrollimine.
| 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. |
Veakoodid
-10231 No company found!
Krediidiinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.
(vt lisaks üldiseid veakoode)