(Xojo Plugin) Cerved API Advanced Entity Search

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.

For more information, see https://apps-developer.cerved.com/

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

// 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"
// }

Dim json As New Chilkat.JsonObject
// IMPORTANT:  Only include the lines for the search criteria you wish to include.
success = json.UpdateString("search_text","string")
success = json.UpdateString("activity_status_codes[0]","A")
success = json.UpdateString("activity_status_codes[1]","C")
success = json.UpdateString("activity_status_codes[2]","D")
success = json.UpdateString("activity_status_codes[3]","F")
success = json.UpdateString("activity_status_codes[4]","I")
success = json.UpdateString("activity_status_codes[5]","L")
success = json.UpdateString("activity_status_codes[6]","N")
success = json.UpdateString("activity_status_codes[7]","P")
success = json.UpdateString("activity_status_codes[8]","R")
success = json.UpdateString("activity_status_codes[9]","S")
success = json.UpdateString("activity_status_codes[10]","T")
success = json.UpdateString("birth_date","string")
success = json.UpdateString("name","string")
success = json.UpdateString("subject_types[0]","PERSON")
success = json.UpdateString("subject_types[1]","INDIVIDUAL_COMPANY")
success = json.UpdateString("subject_types[2]","COMPANY")
success = json.UpdateString("subject_types[3]","FOREIGN")
success = json.UpdateString("subject_types[4]","OTHER")
success = json.UpdateString("tax_code","string")
success = json.UpdateString("vat_number","string")
success = json.UpdateString("rea.cciaa","string")
success = json.UpdateInt("rea.rea_number",0)
success = json.UpdateString("city_istat_code","string")
success = json.UpdateString("province_code","string")

http.SetRequestHeader "accept","application/json"
http.SetRequestHeader "apikey","********************************"

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.cerved.com/cervedApi/v1/entitySearch/advanced","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim subject_id As String
Dim subject_type As String
Dim tax_code As String
Dim addressStreetDescription As String
Dim addressCityCode As String
Dim addressCityIstat_code As String
Dim addressCityDescription As String
Dim addressProvinceCode As String
Dim addressProvinceDescription As String
Dim addressPostal_code As String
Dim addressCountryCode As String
Dim addressCountryDescription As String
Dim company_infoLegal_formCode As String
Dim company_infoLegal_formDescription As String
Dim company_infoLegal_formClass_code As String
Dim company_infoActivity_statusCode As String
Dim company_infoActivity_statusDescription As String
Dim company_infoBusiness_name As String
Dim company_infoEconomic_activityAtecoCode As String
Dim company_infoEconomic_activityAtecoDescription As String
Dim company_infoHead_office As String
Dim company_infoLei_code As String
Dim company_infoOperational_flag As String
Dim company_infoPublic_administrationPa_subject As String
Dim company_infoPublic_administrationPa_supplier As String
Dim company_infoPublic_administrationPa_owned As String
Dim company_infoRea_codeCciaa As String
Dim company_infoRea_codeRea_number As Int32
Dim company_infoRea_codeRegistration_date As String
Dim company_infoVat_number As String
Dim company_infoNo_rea_dataForm_code As String
Dim company_infoNo_rea_dataForm_description As String
Dim person_infoFirst_name As String
Dim person_infoLast_name As String
Dim person_infoName As String
Dim person_infoBirth_date As String
Dim person_infoBirth_placeStreetDescription As String
Dim person_infoBirth_placeCityCode As String
Dim person_infoBirth_placeCityIstat_code As String
Dim person_infoBirth_placeCityDescription As String
Dim person_infoBirth_placeProvinceCode As String
Dim person_infoBirth_placeProvinceDescription As String
Dim person_infoBirth_placePostal_code As String
Dim person_infoBirth_placeCountryCode As String
Dim person_infoBirth_placeCountryDescription As String

Dim subjects_total_number As Int32
subjects_total_number = jResp.IntOf("subjects_total_number")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("subjects")
While i < count_i
    jResp.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
Wend