KiCompanyBasic en - Revision history

Paavo at 12:08, 6 December 2016

2016-12-06T12:08:00Z

← Older revision		Revision as of 15:08, 6 December 2016
Line 114:		Line 114:
	<?php		<?php
	/**		/**
	* Example of using KiCompanyBasic web service of ~~Krediidiinfo~~ AS.		* Example of using KiCompanyBasic web service of Creditinfo Eesti AS.
	*/		*/
	$param = array('encoding'=>'ISO-8859-13');		$param = array('encoding'=>'ISO-8859-13');
Line 157:		Line 157:
	(		(
	[regCode] => 10256137		[regCode] => 10256137
	[name] => ~~KREDIIDIINFO~~ AS		[name] => CREDITINFO EESTI AS
	)		)

	)		)
	Registry code 10256137 belongs to the company ~~KREDIIDIINFO~~ AS		Registry code 10256137 belongs to the company CREDITINFO EESTI AS
	Registry code is incorrect.		Registry code is incorrect.
	</pre>		</pre>

Kart: /* Introduction */

2013-10-01T06:49:08Z

Introduction

← Older revision		Revision as of 09:49, 1 October 2013
Line 6:		Line 6:
	= Introduction =		= Introduction =

	<span style="color:#CC0000"> <b> Attention! The service KiCompanyBasic will end on 10/1/2013. We suggest to use [KiCompany_en \| KiCompany]] as an alternative. </b></span>		<span style="color:#CC0000"> <b> Attention! The service KiCompanyBasic will end on 10/1/2013. We suggest to use [[KiCompany_en \| KiCompany]] as an alternative. </b></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.		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.

Kart: /* Introduction */

2013-10-01T06:48:37Z

Introduction

← Older revision		Revision as of 09:48, 1 October 2013
Line 6:		Line 6:
	= Introduction =		= Introduction =

	<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>		<span style="color:#CC0000"> <b> Attention! The service KiCompanyBasic will end on 10/1/2013. We suggest to use [KiCompany_en \| KiCompany]] as an alternative. </b></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.		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.

Kart: /* Introduction */

2013-10-01T06:48:12Z

Introduction

← Older revision		Revision as of 09:48, 1 October 2013
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 =

Kart at 11:58, 6 June 2012

2012-06-06T11:58:55Z

← Older revision		Revision as of 14:58, 6 June 2012
Line 86:		Line 86:
	== isRegCodeValid ==		== isRegCodeValid ==

	~~Ettevõtte äriregistri korrektsuse kontrollimine~~.		Verification of company’s registry code.

	{\| style="border-style: solid; border-width: 1px;"		{\| style="border-style: solid; border-width: 1px;"
	!		!
	! ~~Nimi~~		! Name
	! ~~Tüüp~~		! Type
	! ~~Kirjeldus~~		! Description
	\|-		\|-
	\| <b>~~Sisendparameetrid~~:</b>		\| <b>Input parameter:</b>
	\| regCode		\| regCode
	\| xs:string		\| xs:string
	\| ~~Ettevõtte äriregistri kood~~		\| Company’s registry code
	\|-		\|-
	\| <b>~~Väljundparameeter~~:</b>		\| <b>Output parameter:</b>
	\| isValid		\| isValid
	\| xs:boolean		\| xs:boolean
	\| ~~Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige~~.		\| True if registry code given with parameter is an eight-digit number and the last check digit is correct.
	\|}		\|}

	~~= Näidisprogramm PHP-s =~~

	~~Järgnevalt on toodud~~ PHP~~-s kirjutatud~~ KiCompanyBasic ~~veebiteenuse kasutamise näide~~.		= Example in PHP =

			Example of using KiCompanyBasic web service in PHP.

	<pre>		<pre>
	<?php		<?php
	/**		/**
	* Krediidiinfo ~~KiCompanyBasic veebiteenuse kasutamise näidis~~.		* 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 "~~Äriregistri kood~~ {$regCode} ~~kuulub ettevõttele~~ {$name}\n";		echo "Registry code {$regCode} belongs to the company {$name}\n";

	$regCode = '10256136'; // ~~kontrollnumber on vale~~!		$regCode = '10256136'; // check number is invalid!
	if (!$client->isRegCodeValid($regCode)) {		if (!$client->isRegCodeValid($regCode)) {
	echo "~~Äriregistri kood on vigane~~.\n";		echo "Registry code is incorrect.\n";
	} else {		} else {
	echo "~~Äriregistri kood on korrektne~~\n";		echo "Registry code is correct\n";
	}		}
	?>		?>
	</pre>		</pre>

	~~Programmi väljund~~:		Program output:

	<pre>		<pre>
Line 159:		Line 160:

	)		)
	~~Äriregistri kood~~ 10256137 ~~kuulub ettevõttele~~ KREDIIDIINFO AS		Registry code 10256137 belongs to the company KREDIIDIINFO AS
	~~Äriregistri kood on vigane~~.		Registry code is incorrect.
	</pre>		</pre>

Kart at 11:53, 6 June 2012

2012-06-06T11:53:06Z

← Older revision		Revision as of 14:53, 6 June 2012
Line 11:		Line 11:
	= WSDL =		= WSDL =

	KiCompanyBasic ~~WSDL asub aadressil~~ [http://services.krediidiinfo.ee/KiCompanyBasic.wsdl http://services.krediidiinfo.ee/KiCompanyBasic.wsdl].		KiCompanyBasic WDSL is located at [http://services.krediidiinfo.ee/KiCompanyBasic.wsdl http://services.krediidiinfo.ee/KiCompanyBasic.wsdl].

	~~Microsofti arendusvahendite kasutajate jaoks on tehtud teine~~ WSDL: [http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl]. ~~See erineb varasemast~~ WSDL~~-ist selle poolest, et~~ ''RPC/~~encode~~'' ~~asemel kasutatakse~~ ''RPC/~~litteral~~''-i.		WSDL for users of Microsoft Development Tools is located at: [http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl]. It differs from the previous WSDL in that '''RPC/litteral''' is used instead of '''RPC/encode'''.

	= ~~Meetodid~~ =
			= Methods =

	== getName ==		== getName ==

	~~Ettevõtte nime pärimine~~.		Requesting company’s name.

	{\| style="border-style: solid; border-width: 1px;"		{\| style="border-style: solid; border-width: 1px;"
	!		!
	! ~~Nimi~~		! Name
	! ~~Tüüp~~		! Type
	! ~~Kirjeldus~~		! Description
	\|-		\|-
	\| <b>~~Sisendparameetrid~~:</b>		\| <b>Input parameter:</b>
	\| regCode		\| regCode
	\| xs:string		\| xs:string
	\| ~~Ettevõtte äriregistri kood~~.		\| Company’s registry code.
	\|-		\|-
	\| <b>~~Väljundparameeter~~:</b>		\| <b>Output parameter:</b>
	\| name		\| name
	\| xs:string		\| 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~~.		\| 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 ==		== findCompanies ==

	~~Ettevõtete otsimine nime järgi~~. ~~Tulemuseks on massiiv~~, ~~mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode~~.		Searching companies by name. The result is an array, which includes companies’ names and registry codes according to the search string.

	{\| style="border-style: solid; border-width: 1px;"		{\| style="border-style: solid; border-width: 1px;"
	!		!
	! ~~Nimi~~		! Name
	! ~~Tüüp~~		! Type
	! ~~Kirjeldus~~		! Description
	\|-		\|-
	\| <b>~~Sisendparameetrid~~:</b>		\| <b>Input parameter:</b>
	\| regCode		\| regCode
	\| xs:string		\| xs:string
	\| ~~Ettevõtte äriregistri kood~~		\| Company’s registry code
	\|-		\|-
	\| <b></b>		\| <b></b>
	\| count		\| count
	\| xs:int		\| xs:int
	\| ~~Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla.~~ (~~Meetod ei tagasta korraga rohkem kui~~ 100 ~~ettevõtet~~)		\| Maximum number of companies found in the result of the method (The method does not return at once more than 100 companies)
	\|-		\|-
	\| <b>~~Väljundparameeter~~:</b>		\| <b>Output parameter:</b>
	\| companies		\| companies
	\| ResultCompanyIDDataArray		\| ResultCompanyIDDataArray
	\| ~~Indekseeritud massiiv, mille elementideks on~~ ResultCompanyIDData ~~tüüpi elemendid~~.		\| Indexed array which elements are ResultCompanyIDData array elements.
	\|}		\|}

	ResultCompanyIDData ~~on kirje järgmise struktuuriga~~:		ResultCompanyIDData is a record with the following structure:

	{\| style="border-style: solid; border-width: 1px;"		{\| style="border-style: solid; border-width: 1px;"
	!		!
	! ~~Nimi~~		! Name
	! ~~Tüüp~~		! Type
	! ~~Kirjeldus~~		! Description
	\|-		\|-
	\| regCode		\| regCode
	\| xs:string		\| xs:string
	\| ~~Ettevõtte äriregistri kood~~		\| Company’s registry code
	\|-		\|-
	\| name		\| name
	\| xs:string		\| xs:string
	\| ~~Ettevõtte nimi~~.		\| Company’s name.
	\|}		\|}


	== isRegCodeValid ==		== isRegCodeValid ==

Kart at 11:45, 6 June 2012

2012-06-06T11:45:01Z

← Older revision		Revision as of 14:45, 6 June 2012
Line 6:		Line 6:
	= Introduction =		= Introduction =

	KiCompanyBasic on ~~Krediidiinfo~~ SOAP ~~protokollil põhinev veebiteenus ettevõtete registrikoodide pärimiseks ja kontrollimiseks~~. KiCompanyBasic ~~päringud on tasuta kuni~~ 500 ~~päringut kuus~~.		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 =

Kart at 11:43, 6 June 2012

2012-06-06T11:43:56Z

← Older revision		Revision as of 14:43, 6 June 2012
Line 1:		Line 1:
			{\| align="right"
			\| [[Image:Flag of Estonia.svg\|border\|30px]] [[KiCompanyBasic\|eesti keeles]]
			\|}


	= Introduction =		= Introduction =

Kart: Created page with "= Introduction = KiCompanyBasic on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete registrikoodide pärimiseks ja kontrollimiseks. KiCompanyBasic päringud on..."

2012-06-06T11:41:48Z

Created page with "= Introduction = KiCompanyBasic on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete registrikoodide pärimiseks ja kontrollimiseks. KiCompanyBasic päringud on..."

New page

= Introduction =

KiCompanyBasic on Krediidiinfo SOAP protokollil põhinev veebiteenus ettevõtete registrikoodide pärimiseks ja kontrollimiseks. KiCompanyBasic päringud on tasuta kuni 500 päringut kuus.

= WSDL =

KiCompanyBasic WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompanyBasic.wsdl http://services.krediidiinfo.ee/KiCompanyBasic.wsdl].

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: [http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl http://services.krediidiinfo.ee/KiCompanyBasicLit.wsdl]. See erineb varasemast WSDL-ist selle poolest, et ''RPC/encode'' asemel kasutatakse ''RPC/litteral''-i.

= Meetodid =

== getName ==

Ettevõtte nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! 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.

{| style="border-style: solid; border-width: 1px;"
!
! 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:

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| name
| xs:string
| Ettevõtte nimi.
|}

== isRegCodeValid ==

Ettevõtte äriregistri korrektsuse kontrollimine.

{| style="border-style: solid; border-width: 1px;"
!
! 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.
|}

= Näidisprogramm PHP-s =

Järgnevalt on toodud PHP-s kirjutatud KiCompanyBasic veebiteenuse kasutamise näide.

<pre>
<?php
/**
* Krediidiinfo KiCompanyBasic veebiteenuse kasutamise näidis.
*/
$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 "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
echo "Äriregistri kood on vigane.\n";
} else {
echo "Äriregistri kood on korrektne\n";
}
?>
</pre>

Programmi väljund:

<pre>

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
)

)
Äriregistri kood 10256137 kuulub ettevõttele KREDIIDIINFO AS
Äriregistri kood on vigane.
</pre>