CkPython
CkPython
Cerved API Advanced Entity Search
See more Cerved Examples
The "Advanced Entity Search" API allows you to find subjects in the Cerved database that meet specific search criteria, specified through the parameters provided as input to the service.Chilkat CkPython Downloads
import sys
import chilkat
success = False
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
# Implements the following CURL command:
# curl -X POST \
# https://api.cerved.com/cervedApi/v1/entitySearch/advanced \
# -H 'accept: application/json' \
# -H 'apikey: ********************************' \
# -d '{
# "search_text": "string",
# "activity_status_codes": [
# "A",
# "C",
# "D",
# "F",
# "I",
# "L",
# "N",
# "P",
# "R",
# "S",
# "T"
# ],
# "birth_date": "string",
# "name": "string",
# "subject_types": [
# "PERSON",
# "INDIVIDUAL_COMPANY",
# "COMPANY",
# "FOREIGN",
# "OTHER"
# ],
# "tax_code": "string",
# "vat_number": "string",
# "rea": {
# "cciaa": "string",
# "rea_number": 0
# },
# "city_istat_code": "string",
# "province_code": "string"
# }'
# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code
# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "search_text": "string",
# "activity_status_codes": [
# "A",
# "C",
# "D",
# "F",
# "I",
# "L",
# "N",
# "P",
# "R",
# "S",
# "T"
# ],
# "birth_date": "string",
# "name": "string",
# "subject_types": [
# "PERSON",
# "INDIVIDUAL_COMPANY",
# "COMPANY",
# "FOREIGN",
# "OTHER"
# ],
# "tax_code": "string",
# "vat_number": "string",
# "rea": {
# "cciaa": "string",
# "rea_number": 0
# },
# "city_istat_code": "string",
# "province_code": "string"
# }
json = chilkat.CkJsonObject()
# IMPORTANT: Only include the lines for the search criteria you wish to include.
json.UpdateString("search_text","string")
json.UpdateString("activity_status_codes[0]","A")
json.UpdateString("activity_status_codes[1]","C")
json.UpdateString("activity_status_codes[2]","D")
json.UpdateString("activity_status_codes[3]","F")
json.UpdateString("activity_status_codes[4]","I")
json.UpdateString("activity_status_codes[5]","L")
json.UpdateString("activity_status_codes[6]","N")
json.UpdateString("activity_status_codes[7]","P")
json.UpdateString("activity_status_codes[8]","R")
json.UpdateString("activity_status_codes[9]","S")
json.UpdateString("activity_status_codes[10]","T")
json.UpdateString("birth_date","string")
json.UpdateString("name","string")
json.UpdateString("subject_types[0]","PERSON")
json.UpdateString("subject_types[1]","INDIVIDUAL_COMPANY")
json.UpdateString("subject_types[2]","COMPANY")
json.UpdateString("subject_types[3]","FOREIGN")
json.UpdateString("subject_types[4]","OTHER")
json.UpdateString("tax_code","string")
json.UpdateString("vat_number","string")
json.UpdateString("rea.cciaa","string")
json.UpdateInt("rea.rea_number",0)
json.UpdateString("city_istat_code","string")
json.UpdateString("province_code","string")
http.SetRequestHeader("accept","application/json")
http.SetRequestHeader("apikey","********************************")
resp = chilkat.CkHttpResponse()
success = http.HttpJson("POST","https://api.cerved.com/cervedApi/v1/entitySearch/advanced",json,"application/json",resp)
if (success == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "subjects": [
# {
# "subject_id": "string",
# "subject_type": "string",
# "tax_code": "string",
# "address": {
# "street": {
# "description": "string"
# },
# "city": {
# "code": "string",
# "istat_code": "string",
# "description": "string"
# },
# "province": {
# "code": "string",
# "description": "string"
# },
# "postal_code": "string",
# "country": {
# "code": "string",
# "description": "string"
# }
# },
# "company_info": {
# "legal_form": {
# "code": "string",
# "description": "string",
# "class_code": "string"
# },
# "activity_status": {
# "code": "string",
# "description": "string"
# },
# "business_name": "string",
# "economic_activity": {
# "ateco": {
# "code": "string",
# "description": "string"
# }
# },
# "head_office": "true",
# "lei_code": "string",
# "operational_flag": "true",
# "public_administration": {
# "pa_subject": "true",
# "pa_supplier": "true",
# "pa_owned": "true"
# },
# "rea_code": {
# "cciaa": "string",
# "rea_number": 0,
# "registration_date": "string"
# },
# "vat_number": "string",
# "no_rea_data": {
# "form_code": "string",
# "form_description": "string"
# }
# },
# "person_info": {
# "first_name": "string",
# "last_name": "string",
# "name": "string",
# "birth_date": "string",
# "birth_place": {
# "street": {
# "description": "string"
# },
# "city": {
# "code": "string",
# "istat_code": "string",
# "description": "string"
# },
# "province": {
# "code": "string",
# "description": "string"
# },
# "postal_code": "string",
# "country": {
# "code": "string",
# "description": "string"
# }
# }
# }
# }
# ],
# "subjects_total_number": 0
# }
# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON
subjects_total_number = jResp.IntOf("subjects_total_number")
i = 0
count_i = jResp.SizeOfArray("subjects")
while i < count_i :
jResp.put_I(i)
subject_id = jResp.stringOf("subjects[i].subject_id")
subject_type = jResp.stringOf("subjects[i].subject_type")
tax_code = jResp.stringOf("subjects[i].tax_code")
addressStreetDescription = jResp.stringOf("subjects[i].address.street.description")
addressCityCode = jResp.stringOf("subjects[i].address.city.code")
addressCityIstat_code = jResp.stringOf("subjects[i].address.city.istat_code")
addressCityDescription = jResp.stringOf("subjects[i].address.city.description")
addressProvinceCode = jResp.stringOf("subjects[i].address.province.code")
addressProvinceDescription = jResp.stringOf("subjects[i].address.province.description")
addressPostal_code = jResp.stringOf("subjects[i].address.postal_code")
addressCountryCode = jResp.stringOf("subjects[i].address.country.code")
addressCountryDescription = jResp.stringOf("subjects[i].address.country.description")
company_infoLegal_formCode = jResp.stringOf("subjects[i].company_info.legal_form.code")
company_infoLegal_formDescription = jResp.stringOf("subjects[i].company_info.legal_form.description")
company_infoLegal_formClass_code = jResp.stringOf("subjects[i].company_info.legal_form.class_code")
company_infoActivity_statusCode = jResp.stringOf("subjects[i].company_info.activity_status.code")
company_infoActivity_statusDescription = jResp.stringOf("subjects[i].company_info.activity_status.description")
company_infoBusiness_name = jResp.stringOf("subjects[i].company_info.business_name")
company_infoEconomic_activityAtecoCode = jResp.stringOf("subjects[i].company_info.economic_activity.ateco.code")
company_infoEconomic_activityAtecoDescription = jResp.stringOf("subjects[i].company_info.economic_activity.ateco.description")
company_infoHead_office = jResp.stringOf("subjects[i].company_info.head_office")
company_infoLei_code = jResp.stringOf("subjects[i].company_info.lei_code")
company_infoOperational_flag = jResp.stringOf("subjects[i].company_info.operational_flag")
company_infoPublic_administrationPa_subject = jResp.stringOf("subjects[i].company_info.public_administration.pa_subject")
company_infoPublic_administrationPa_supplier = jResp.stringOf("subjects[i].company_info.public_administration.pa_supplier")
company_infoPublic_administrationPa_owned = jResp.stringOf("subjects[i].company_info.public_administration.pa_owned")
company_infoRea_codeCciaa = jResp.stringOf("subjects[i].company_info.rea_code.cciaa")
company_infoRea_codeRea_number = jResp.IntOf("subjects[i].company_info.rea_code.rea_number")
company_infoRea_codeRegistration_date = jResp.stringOf("subjects[i].company_info.rea_code.registration_date")
company_infoVat_number = jResp.stringOf("subjects[i].company_info.vat_number")
company_infoNo_rea_dataForm_code = jResp.stringOf("subjects[i].company_info.no_rea_data.form_code")
company_infoNo_rea_dataForm_description = jResp.stringOf("subjects[i].company_info.no_rea_data.form_description")
person_infoFirst_name = jResp.stringOf("subjects[i].person_info.first_name")
person_infoLast_name = jResp.stringOf("subjects[i].person_info.last_name")
person_infoName = jResp.stringOf("subjects[i].person_info.name")
person_infoBirth_date = jResp.stringOf("subjects[i].person_info.birth_date")
person_infoBirth_placeStreetDescription = jResp.stringOf("subjects[i].person_info.birth_place.street.description")
person_infoBirth_placeCityCode = jResp.stringOf("subjects[i].person_info.birth_place.city.code")
person_infoBirth_placeCityIstat_code = jResp.stringOf("subjects[i].person_info.birth_place.city.istat_code")
person_infoBirth_placeCityDescription = jResp.stringOf("subjects[i].person_info.birth_place.city.description")
person_infoBirth_placeProvinceCode = jResp.stringOf("subjects[i].person_info.birth_place.province.code")
person_infoBirth_placeProvinceDescription = jResp.stringOf("subjects[i].person_info.birth_place.province.description")
person_infoBirth_placePostal_code = jResp.stringOf("subjects[i].person_info.birth_place.postal_code")
person_infoBirth_placeCountryCode = jResp.stringOf("subjects[i].person_info.birth_place.country.code")
person_infoBirth_placeCountryDescription = jResp.stringOf("subjects[i].person_info.birth_place.country.description")
i = i + 1