Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{secretId}}"
CkHttp_put_Password $http "{{secretPassword}}"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/api/tax-status/:id/" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set id [CkJsonObject_stringOf $jResp "id"]
set link [CkJsonObject_stringOf $jResp "link"]
set collected_at [CkJsonObject_stringOf $jResp "collected_at"]
set place_and_date_of_issuance [CkJsonObject_stringOf $jResp "place_and_date_of_issuance"]
set official_name [CkJsonObject_stringOf $jResp "official_name"]
set id_cif [CkJsonObject_stringOf $jResp "id_cif"]
set Rfc [CkJsonObject_stringOf $jResp "tax_payer_information.rfc"]
set Curp [CkJsonObject_stringOf $jResp "tax_payer_information.curp"]
set Name [CkJsonObject_stringOf $jResp "tax_payer_information.name"]
set First_last_name [CkJsonObject_stringOf $jResp "tax_payer_information.first_last_name"]
set Second_last_name [CkJsonObject_stringOf $jResp "tax_payer_information.second_last_name"]
set Start_operations_date [CkJsonObject_stringOf $jResp "tax_payer_information.start_operations_date"]
set Status_padron [CkJsonObject_stringOf $jResp "tax_payer_information.status_padron"]
set Last_status_change_date [CkJsonObject_stringOf $jResp "tax_payer_information.last_status_change_date"]
set Commercial_name [CkJsonObject_stringOf $jResp "tax_payer_information.commercial_name"]
set Social_name [CkJsonObject_stringOf $jResp "tax_payer_information.social_name"]
set v_Email [CkJsonObject_stringOf $jResp "tax_payer_information.email"]
set Phone [CkJsonObject_stringOf $jResp "tax_payer_information.phone"]
set Postal_code [CkJsonObject_stringOf $jResp "address.postal_code"]
set Street_type [CkJsonObject_stringOf $jResp "address.street_type"]
set Street [CkJsonObject_stringOf $jResp "address.street"]
set Exterior_number [CkJsonObject_stringOf $jResp "address.exterior_number"]
set Interior_number [CkJsonObject_stringOf $jResp "address.interior_number"]
set Suburb [CkJsonObject_stringOf $jResp "address.suburb"]
set Locality [CkJsonObject_stringOf $jResp "address.locality"]
set Municipality [CkJsonObject_stringOf $jResp "address.municipality"]
set State [CkJsonObject_stringOf $jResp "address.state"]
set Value [CkJsonObject_stringOf $jResp "address.between_street.value"]
set Obligation [CkJsonObject_stringOf $jResp "obligations.obligation"]
set Expiration [CkJsonObject_stringOf $jResp "obligations.expiration"]
set Initial_date [CkJsonObject_stringOf $jResp "obligations.initial_date"]
set End_date [CkJsonObject_stringOf $jResp "obligations.end_date"]
set personal_information [CkJsonObject_stringOf $jResp "personal_information"]
set digital_stamp [CkJsonObject_stringOf $jResp "digital_stamp"]
set digital_stamp_chain [CkJsonObject_stringOf $jResp "digital_stamp_chain"]
set pdf [CkJsonObject_stringOf $jResp "pdf"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "economic_activity"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set economic_activityValue [CkJsonObject_stringOf $jResp "economic_activity[i].economic_activity.value"]
set end_dateValue [CkJsonObject_stringOf $jResp "economic_activity[i].end_date.value"]
set initial_dateValue [CkJsonObject_stringOf $jResp "economic_activity[i].initial_date.value"]
set orderValue [CkJsonObject_stringOf $jResp "economic_activity[i].order.value"]
set percentageValue [CkJsonObject_stringOf $jResp "economic_activity[i].percentage.value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "regimens"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set end_dateValue [CkJsonObject_stringOf $jResp "regimens[i].end_date.value"]
set initial_dateValue [CkJsonObject_stringOf $jResp "regimens[i].initial_date.value"]
set regimenValue [CkJsonObject_stringOf $jResp "regimens[i].regimen.value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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]"
}
]
}
