KiCompanyBasic en: Difference between revisions
No edit summary |
No edit summary |
||
| Line 86: | Line 86: | ||
== isRegCodeValid == | == isRegCodeValid == | ||
Verification of company’s registry code. | |||
{| style="border-style: solid; border-width: 1px;" | {| style="border-style: solid; border-width: 1px;" | ||
! | ! | ||
! | ! Name | ||
! | ! Type | ||
! | ! Description | ||
|- | |- | ||
| <b> | | <b>Input parameter:</b> | ||
| regCode | | regCode | ||
| xs:string | | xs:string | ||
| | | Company’s registry code | ||
|- | |- | ||
| <b> | | <b>Output parameter:</b> | ||
| isValid | | isValid | ||
| xs:boolean | | 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. | |||
<pre> | <pre> | ||
<?php | <?php | ||
/** | /** | ||
* Krediidiinfo | * Example of using KiCompanyBasic web service of Krediidiinfo AS. | ||
*/ | */ | ||
$param = array('encoding'=>'ISO-8859-13'); | $param = array('encoding'=>'ISO-8859-13'); | ||
| Line 123: | Line 124: | ||
$regCode = '10256137'; | $regCode = '10256137'; | ||
$name = $client->getName($regCode); | $name = $client->getName($regCode); | ||
echo " | echo "Registry code {$regCode} belongs to the company {$name}\n"; | ||
$regCode = '10256136'; // | $regCode = '10256136'; // check number is invalid! | ||
if (!$client->isRegCodeValid($regCode)) { | if (!$client->isRegCodeValid($regCode)) { | ||
echo " | echo "Registry code is incorrect.\n"; | ||
} else { | } else { | ||
echo " | echo "Registry code is correct\n"; | ||
} | } | ||
?> | ?> | ||
</pre> | </pre> | ||
Program output: | |||
<pre> | <pre> | ||
| Line 159: | Line 160: | ||
) | ) | ||
Registry code 10256137 belongs to the company KREDIIDIINFO AS | |||
Registry code is incorrect. | |||
</pre> | </pre> | ||
Revision as of 13:58, 6 June 2012
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.
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.