GetSubjectBasicReport - CZ

Description and definition

Versions:

001 document base

002 document’s extensions

error messages
ISIR url
Domiciles ic

003 description for new response from web method.

The client’s debug support
Collections of data domain
Versioning of response

004 Justitia CZ. Fix of reportVersion element.

Description

The web service method for subject’s info genaration. This method returned information about credit risk data.

Credit risk data

Output contais data from ISIR, VZP, ZPMVCR and DOMICILES.

The reportVersion = 2 contains other data:

Id card validity. Stolen or lost.
Birth number validity
Data collections
Real estate
Execution registry.

From 2014/03 exists a Justitia data inside version 2.

Web method input parameters:

The web method has the one input parameter only. This parameter is a XML with subject’s data.

name	datatype	mandatory	Notice
subjectData	XMLDocument	yes

Web method output data:

The output is XML with any information about risks or about subject’s state. In error case output contains an error information.

datatype	mandatory	Notice
XMLDocument	yes

SOAP header:

The web method has the SOAP header.. This header contains login values..

SOAP header

<soap:Header>
<CreditCheckHeader
xmlns="http://creditcheck.cz/">
<Login>string</Login>
<Password>string</Password>
</CreditCheckHeader>
</soap:Header>

WSDL

WSDL bellow will be available on url http://creditwebservices.creditcheck.cz/CreditCheckAktualizace.asmx?op=GetBasicReport

SOAP 1.1

SOAP 1.1.

POST /CreditCheckWebServices/CreditCheckAktualizace.asmx HTTP/1.1
Host: creditwebservices.creditcheck.cz
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://creditcheck.cz/GetSubjectBasicReport"


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<CreditCheckHeader xmlns="http://creditcheck.cz/">
<Login>string</Login>
<Password>string</Password>
</CreditCheckHeader>
</soap:Header>
<soap:Body>
<GetSubjectBasicReport xmlns="http://creditcheck.cz/">
<subjectData>xml</subjectData>
</GetSubjectBasicReport>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSubjectBasicReportResponse xmlns="http://creditcheck.cz/">
<GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult>
</GetSubjectBasicReportResponse>
</soap:Body>
</soap:Envelope>

SOAP 1.2

SOAP 1.2

POST /CreditCheckWebServices/CreditCheckAktualizace.asmx HTTP/1.1
Host: creditwebservices.creditcheck.cz
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length


<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<CreditCheckHeader xmlns="http://creditcheck.cz/">
<Login>string</Login>
<Password>string</Password>
</CreditCheckHeader>
</soap12:Header>
<soap12:Body>
<GetSubjectBasicReport xmlns="http://creditcheck.cz/">
<subjectData>xml</subjectData>
</GetSubjectBasicReport>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length


<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSubjectBasicReportResponse xmlns="http://creditcheck.cz/">
<GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult>
</GetSubjectBasicReportResponse>
</soap12:Body>
</soap12:Envelope>

Requests to webmethod - input parameter description

You must put valid XML into parameter. This XML has 1 types of structure.

Type 1: request for private person

private person request

<requestSubject>
<reportVersion>2</reportVersion>
<subjectType>privatePerson</subjectType>
<birthNumber>7710109856</birthNumber>
<firstName>Jan</firstName>
<surname>Novák</surname>
<address>
<street>Krátká</street>
<number>8</number>
<city>Praha</city>
<zip>10100</zip>
</address>
<idCard>123456KK</idCard>
<checkInExecutionRegistry>1</ checkInExecutionRegistry >
<checkInRealEstate>1</checkInRealEstate >
<checkInJustitiaCz>1</checkInJustitiaCz>
reportVersion
</requestSubject>

Element name	datatype	mandatory	Notice
subjectType	string	yes	privatePerson
birthNumber	string	yes
firstName	string	yes
surname	string	yes
address			Root element for data of address.
street	string	yes
number	string	yes
city	string	yes
zip	string	yes
idCard	string	no	The reportVersion 2 only.
reportVersion	string	no	If exist this element and value is 2 then response will contains all relevant data for current data domain. Data will return as collection. Some data domains are unique and collections not exists. Look on current collection.
checkInExecutionRegistry	string	no	The reportVersion 2 only. When element exists and value is 1 than subject will check in the Execution database.
checkInRealEstate	string	no	The reportVersion 2 only. When element exists and value is 1 than subject will check in the Real estate database.
checkInJustitiaCz	string	no	From 2014/03 and reportVersion 2 only. When element exists and value is 1 than subject wil check in the Justitia CZ registry.

Response from webmethod - data description

The Real estate and Execution database is in evolution.

Type 1: response for private person request

private person response

<creditCheck version="1.0" encoding="utf-8" >
<webMethod>GetSubjectBasicReport</webMethod>
<time>21.10.2011 8:43:36</time>
<requestSubject>
<requestVersion>2</requestVersion>
<subjectType>privatePerson</subjectType>
<birthNumber>7710109856</birthNumber>
<firstName>Jan</firstName>
<surname>Novák</surname>
<address>
<street>Krátká</street>
<number>8</number>
<city>Praha</city>
<zip>10100</zip>
</address>
<idCard>123456KK</idCard>
<checkInExecutionRegistry>1</ checkInExecutionRegistry >
</requestSubject>
<report>
<status>3</status>
<fullReportUrl>http//...</ fullReportUrl>
<birthNumber>7710109856</birthNumber>
<firstName>Jan</firstName>
<surname>Novák</surname>
<ic>701689523</ic>
<idCard>OK</idCard>
<invalidBirthNumber>INVALID</invalidBirthNumber>
<isir>
<isirRecord>
<id>5698</id>
<spisZnacka>INS 4/2008</spisZnacka>
<cas>2008-01-02 12:49:37.000</cas>
<udalost>Sdělení</udalost>
<druhStavRizeni>NEVYRIZENA</druhStavRizeni>
<isirUrl>https://isir.justice.cz/...</isirUrl> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl>
</isirRecord>
</isir>
<vzp>
<vzpRecord>
<id>458</id>
<privateFullName>Jan Novák</privateFullName>
<dluhCelkem>300219</dluhCelkem>
<evidovanoOd>2010-02-11 10:07:40.613</evidovanoOd>
<evidovanoDo>2010-09-11 11:07:40.613</evidovanoDo>
<birthDate>20.12.1968</birthDate>
<address> Komenského 218, 280 02 Kolín</address>
</vzpRecord>
<vzpRecord>
<id>658</id>
<privateFullName>Jan Novák</privateFullName>
<dluhCelkem>10219</dluhCelkem>
<evidovanoOd>2012-02-11 10:07:40.613</evidovanoOd>
<evidovanoDo>2012-09-11 11:07:40.613</evidovanoDo>
<address> Komenského 6, Kolín</address>
</vzpRecord>
</vzp>
<zpmvcr>
<zpmvcrRecord>
<id>623</id>
<privateFullName>Jan Novák</privateFullName>
<dluhCelkem>466473</dluhCelkem>
<evidovanoOd>2010-02-11 10:07:40.613</evidovanoOd>
<birthYear>1968</ birthYear >
<address> Komenského 218, Kolín</address>
</zpmvcrRecord>
<zpmvcrRecord>
<id>623</id>
<privateFullName>Jan Novák</privateFullName>
<dluhCelkem>35</dluhCelkem>
<evidovanoOd>2010-02-11 10:07:40.613</evidovanoOd>
<evidovanoDo>2012-09-11 11:07:40.613</evidovanoDo>
<birthYear>1968</ birthYear >
<address> Komenského 6, Kolín</address>
</zpmvcrRecord>
</zpmvcr>
<domicileMunicipality >
<muniName>Obecní úřad Praha 6</muniName>>
<fullAddress>Krátká 8/12, Praha, 30100</fullAddress>
</domicileMunicipality>
</report>
</creditCheck>

Element name	datatype	mandatory	Notice
webMethod	string	yes	Name of web service method
time	datetime	yes	Time of data generation on our server
requestSubject		yes	Root element with input data.
subjectType	string	yes	privatePerson
birthNumber	string	yes
firstName	string	yes
surname	string	yes
address			Root element for data of address.
street	string	yes
number	string	yes
city	string	yes
zip	string	yes
report			Root element for data with risk info.
status	int	no	CreditCheck status. This value will display when subject is same as privateBussines subject inside our database. It is same as ic element.
fullReportUrl	string	yes	Url to CreditCheck FullReport as timelink.
birthNumber	string	yes
firstName	string	yes
surname	string	yes
address			Root element for data of address.
street	string	yes
number	string	yes
city	string	yes
zip	string	yes
ic	string	no	This value will display when subject is same as privateBussines subject inside our database.
idCard	String	no	When requestVersion is 2 only. This element have got two values. OK = card is OK. INVALID = card was stolen , lost or other problem.
invalidBirthNumber	String	no	When requestVersion is 2 only. This element will show when our validation of birth number was wrong. Value element inside will INVALID . When birth number is right then element missing.
isir		no	Root element for the ISIR risk data. When subject has not ISIR risk data then element will not exist. Last record from database only. This data domain is unique and collection not exist.
isirRecord			Envelope element for one record.
id	int	yes	Record Id from our database.
spisZnacka	string	yes
cas	datetime	yes
udalost	string	yes
druhStavRizeni	string	yes
isirUrl	string	yes	Link directtly to ISIR page.
dokumentUrl	string	yes	Link directtly to document’s copy on ISIR pages.
vzp		no	Root element for the VZP risk data. When subject has not VZP risk data then element will not exist. When the requestVersion element missing than last record from database only. Esle when the requestElement exists and value is 2 then data are as collection.
vzpRecord			Envelope element for one record.
id	int	yes	Record id from our database.
privateFullName	string	yes	If the requestVersion element exists and value is 2.
dluhCelkem	number	yes	Total debt
evidovanoOd	datetime	yes	Evidence from. (In our database.)
evidovanoDo	datetime	no	Evidence to. (In our database.) If don’t exists then record is current.
birthDate	string	no	If the requestVersion element exists and value is 2.
address	string	No	If the requestVersion element exists and value is 2.
zpmvcr		no	Root element for the ZP MVCR risk data. When subject has not ZP MVCR risk data then element will not exist. When the requestVersion element missing than last record from database only. Esle when the requestElement exists and value is 2 then data are as collection.
zpmvcr Record			Envelope element for one record.
id	int	yes	Record id from our database.
privateFullName	string	yes	If the requestVersion element exists and value is 2.
dluhCelkem	number	yes	Total debt
evidovanoOd	datetime	yes	Evidence from. (In our database.)
evidovanoDo	datetime	no	Evidence to. (In our database.) If don’t exists then record is current.
birthYear	string	no	If the requestVersion element exists and value is 2.
address	string	No	If the requestVersion element exists and value is 2.
domicileMunicipality		no	Root element for the Domicile risk. When subject has not Domicile risk data then element will not exist.
muniName	string	no	Name of municipality
fullAddress	string	yes	Full municipality address.

Example for subject without credit risk data