Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"
Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/api/tax-status/:id/",sbResponseBody)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print http.LastHeader
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "id": "<uuid>",
' "link": "<uuid>",
' "collected_at": "<dateTime>",
' "place_and_date_of_issuance": "<string>",
' "official_name": "<string>",
' "id_cif": "<string>",
' "tax_payer_information": {
' "rfc": "<string>",
' "curp": "<string>",
' "name": "<string>",
' "first_last_name": "<string>",
' "second_last_name": "<string>",
' "start_operations_date": "<string>",
' "status_padron": "<string>",
' "last_status_change_date": "<string>",
' "commercial_name": "<string>",
' "social_name": "<string>",
' "email": "<string>",
' "phone": "<string>"
' },
' "address": {
' "postal_code": "<string>",
' "street_type": "<string>",
' "street": "<string>",
' "exterior_number": "<string>",
' "interior_number": "<string>",
' "suburb": "<string>",
' "locality": "<string>",
' "municipality": "<string>",
' "state": "<string>",
' "between_street": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' "economic_activity": [
' {
' "economic_activity": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "end_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "initial_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "order": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "percentage": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' {
' "economic_activity": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "end_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "initial_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "order": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "percentage": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' }
' ],
' "regimens": [
' {
' "end_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "initial_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "regimen": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' {
' "end_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "initial_date": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "regimen": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' }
' ],
' "obligations": {
' "obligation": "<string>",
' "expiration": "<string>",
' "initial_date": "<string>",
' "end_date": "<string>"
' },
' "personal_information": "<object>",
' "digital_stamp": "<string>",
' "digital_stamp_chain": "<string>",
' "pdf": "<binary>"
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim economic_activityValue As String
Dim end_dateValue As String
Dim initial_dateValue As String
Dim orderValue As String
Dim percentageValue As String
Dim regimenValue As String
Dim id As String
id = jResp.StringOf("id")
Dim link As String
link = jResp.StringOf("link")
Dim collected_at As String
collected_at = jResp.StringOf("collected_at")
Dim place_and_date_of_issuance As String
place_and_date_of_issuance = jResp.StringOf("place_and_date_of_issuance")
Dim official_name As String
official_name = jResp.StringOf("official_name")
Dim id_cif As String
id_cif = jResp.StringOf("id_cif")
Dim Rfc As String
Rfc = jResp.StringOf("tax_payer_information.rfc")
Dim Curp As String
Curp = jResp.StringOf("tax_payer_information.curp")
Dim Name As String
Name = jResp.StringOf("tax_payer_information.name")
Dim First_last_name As String
First_last_name = jResp.StringOf("tax_payer_information.first_last_name")
Dim Second_last_name As String
Second_last_name = jResp.StringOf("tax_payer_information.second_last_name")
Dim Start_operations_date As String
Start_operations_date = jResp.StringOf("tax_payer_information.start_operations_date")
Dim Status_padron As String
Status_padron = jResp.StringOf("tax_payer_information.status_padron")
Dim Last_status_change_date As String
Last_status_change_date = jResp.StringOf("tax_payer_information.last_status_change_date")
Dim Commercial_name As String
Commercial_name = jResp.StringOf("tax_payer_information.commercial_name")
Dim Social_name As String
Social_name = jResp.StringOf("tax_payer_information.social_name")
Dim v_Email As String
v_Email = jResp.StringOf("tax_payer_information.email")
Dim Phone As String
Phone = jResp.StringOf("tax_payer_information.phone")
Dim Postal_code As String
Postal_code = jResp.StringOf("address.postal_code")
Dim Street_type As String
Street_type = jResp.StringOf("address.street_type")
Dim Street As String
Street = jResp.StringOf("address.street")
Dim Exterior_number As String
Exterior_number = jResp.StringOf("address.exterior_number")
Dim Interior_number As String
Interior_number = jResp.StringOf("address.interior_number")
Dim Suburb As String
Suburb = jResp.StringOf("address.suburb")
Dim Locality As String
Locality = jResp.StringOf("address.locality")
Dim Municipality As String
Municipality = jResp.StringOf("address.municipality")
Dim State As String
State = jResp.StringOf("address.state")
Dim Value As String
Value = jResp.StringOf("address.between_street.value")
Dim Obligation As String
Obligation = jResp.StringOf("obligations.obligation")
Dim Expiration As String
Expiration = jResp.StringOf("obligations.expiration")
Dim Initial_date As String
Initial_date = jResp.StringOf("obligations.initial_date")
Dim End_date As String
End_date = jResp.StringOf("obligations.end_date")
Dim personal_information As String
personal_information = jResp.StringOf("personal_information")
Dim digital_stamp As String
digital_stamp = jResp.StringOf("digital_stamp")
Dim digital_stamp_chain As String
digital_stamp_chain = jResp.StringOf("digital_stamp_chain")
Dim pdf As String
pdf = jResp.StringOf("pdf")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("economic_activity")
Do While i < count_i
jResp.I = i
economic_activityValue = jResp.StringOf("economic_activity[i].economic_activity.value")
end_dateValue = jResp.StringOf("economic_activity[i].end_date.value")
initial_dateValue = jResp.StringOf("economic_activity[i].initial_date.value")
orderValue = jResp.StringOf("economic_activity[i].order.value")
percentageValue = jResp.StringOf("economic_activity[i].percentage.value")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("regimens")
Do While i < count_i
jResp.I = i
end_dateValue = jResp.StringOf("regimens[i].end_date.value")
initial_dateValue = jResp.StringOf("regimens[i].initial_date.value")
regimenValue = jResp.StringOf("regimens[i].regimen.value")
i = i + 1
Loop
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/tax-status/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `tax-status.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific tax status."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"place_and_date_of_issuance\": \"<string>\",\n\t\"official_name\": \"<string>\",\n\t\"id_cif\": \"<string>\",\n\t\"tax_payer_information\": {\n\t\t\"rfc\": \"<string>\",\n\t\t\"curp\": \"<string>\",\n\t\t\"name\": \"<string>\",\n\t\t\"first_last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"start_operations_date\": \"<string>\",\n\t\t\"status_padron\": \"<string>\",\n\t\t\"last_status_change_date\": \"<string>\",\n\t\t\"commercial_name\": \"<string>\",\n\t\t\"social_name\": \"<string>\",\n\t\t\"email\": \"<string>\",\n\t\t\"phone\": \"<string>\"\n\t},\n\t\"address\": {\n\t\t\"postal_code\": \"<string>\",\n\t\t\"street_type\": \"<string>\",\n\t\t\"street\": \"<string>\",\n\t\t\"exterior_number\": \"<string>\",\n\t\t\"interior_number\": \"<string>\",\n\t\t\"suburb\": \"<string>\",\n\t\t\"locality\": \"<string>\",\n\t\t\"municipality\": \"<string>\",\n\t\t\"state\": \"<string>\",\n\t\t\"between_street\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"economic_activity\": [\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"regimens\": [\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"obligations\": {\n\t\t\"obligation\": \"<string>\",\n\t\t\"expiration\": \"<string>\",\n\t\t\"initial_date\": \"<string>\",\n\t\t\"end_date\": \"<string>\"\n\t},\n\t\"personal_information\": \"<object>\",\n\t\"digital_stamp\": \"<string>\",\n\t\"digital_stamp_chain\": \"<string>\",\n\t\"pdf\": \"<binary>\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
