KiCompanyBasic en: Difference between revisions
No edit summary |
|||
Line 6: | Line 6: | ||
= Introduction = | = Introduction = | ||
KiCompanyBasic is the name of a Web Service based on SOAP protocol for requesting companies’ register codes. KiCompanyBasic requests are free of charge up to 500 queries per month. | <span style="color:#CC0000"> Attention! The service KiCompanyBasic will end on 10/1/2013. We suggest to use [KiCompany_en | KiCompany]] as an alternative. </span> | ||
KiCompanyBasic is the name of a Web Service based on SOAP protocol for requesting companies’ register codes. KiCompanyBasic requests are free of charge up to 500 queries per month. | |||
= WSDL = | = WSDL = |
Revision as of 08:48, 1 October 2013
eesti keeles |
Introduction
Attention! The service KiCompanyBasic will end on 10/1/2013. We suggest to use [KiCompany_en | KiCompany]] as an alternative. KiCompanyBasic is the name of a Web Service based on SOAP protocol for requesting companies’ register codes. KiCompanyBasic requests are free of charge up to 500 queries per month.
WSDL
KiCompanyBasic WDSL is located at http://services.krediidiinfo.ee/KiCompanyBasic.wsdl.
WSDL for users of Microsoft Development Tools is located at: http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl. It differs from the previous WSDL in that RPC/litteral is used instead of RPC/encode.
Methods
getName
Requesting company’s name.
Name | Type | Description | |
---|---|---|---|
Input parameter: | regCode | xs:string | Company’s registry code. |
Output parameter: | name | xs:string | Company’s name. Output value is an empty string if the name is not found (compnay does not exist, error in the registry code etc). |
findCompanies
Searching companies by name. The result is an array, which includes companies’ names and registry codes according to the search string.
Name | Type | Description | |
---|---|---|---|
Input parameter: | regCode | xs:string | Company’s registry code |
count | xs:int | Maximum number of companies found in the result of the method (The method does not return at once more than 100 companies) | |
Output parameter: | companies | ResultCompanyIDDataArray | Indexed array which elements are ResultCompanyIDData array elements. |
ResultCompanyIDData is a record with the following structure:
Name | Type | Description | |
---|---|---|---|
regCode | xs:string | Company’s registry code | |
name | xs:string | Company’s name. |
isRegCodeValid
Verification of company’s registry code.
Name | Type | Description | |
---|---|---|---|
Input parameter: | regCode | xs:string | Company’s registry code |
Output parameter: | isValid | xs:boolean | True if registry code given with parameter is an eight-digit number and the last check digit is correct. |
Example in PHP
Example of using KiCompanyBasic web service in PHP.
<?php /** * Example of using KiCompanyBasic web service of Krediidiinfo AS. */ $param = array('encoding'=>'ISO-8859-13'); $client = new SoapClient('http://services.krediidiinfo.ee/KiCompanyBasic.wsdl', $param); $name = 'KREDIIDI'; $companies = $client->findCompanies($name, 3); print_r($companies); $regCode = '10256137'; $name = $client->getName($regCode); echo "Registry code {$regCode} belongs to the company {$name}\n"; $regCode = '10256136'; // check number is invalid! if (!$client->isRegCodeValid($regCode)) { echo "Registry code is incorrect.\n"; } else { echo "Registry code is correct\n"; } ?>
Program output:
Array ( [0] => Array ( [regCode] => 90006012 [name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SITHASUTUS KREDEX ) [1] => Array ( [regCode] => 10704587 [name] => KREDIIDI JÄRELVALVE OÜ ) [2] => Array ( [regCode] => 10256137 [name] => KREDIIDIINFO AS ) ) Registry code 10256137 belongs to the company KREDIIDIINFO AS Registry code is incorrect.