Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *economic_activityValue;
const wchar_t *end_dateValue;
const wchar_t *initial_dateValue;
const wchar_t *orderValue;
const wchar_t *percentageValue;
const wchar_t *regimenValue;
const wchar_t *id;
const wchar_t *link;
const wchar_t *collected_at;
const wchar_t *place_and_date_of_issuance;
const wchar_t *official_name;
const wchar_t *id_cif;
const wchar_t *Rfc;
const wchar_t *Curp;
const wchar_t *Name;
const wchar_t *First_last_name;
const wchar_t *Second_last_name;
const wchar_t *Start_operations_date;
const wchar_t *Status_padron;
const wchar_t *Last_status_change_date;
const wchar_t *Commercial_name;
const wchar_t *Social_name;
const wchar_t *v_Email;
const wchar_t *Phone;
const wchar_t *Postal_code;
const wchar_t *Street_type;
const wchar_t *Street;
const wchar_t *Exterior_number;
const wchar_t *Interior_number;
const wchar_t *Suburb;
const wchar_t *Locality;
const wchar_t *Municipality;
const wchar_t *State;
const wchar_t *Value;
const wchar_t *Obligation;
const wchar_t *Expiration;
const wchar_t *Initial_date;
const wchar_t *End_date;
const wchar_t *personal_information;
const wchar_t *digital_stamp;
const wchar_t *digital_stamp_chain;
const wchar_t *pdf;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"{{secretId}}");
CkHttpW_putPassword(http,L"{{secretPassword}}");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/api/tax-status/:id/",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
id = CkJsonObjectW_stringOf(jResp,L"id");
link = CkJsonObjectW_stringOf(jResp,L"link");
collected_at = CkJsonObjectW_stringOf(jResp,L"collected_at");
place_and_date_of_issuance = CkJsonObjectW_stringOf(jResp,L"place_and_date_of_issuance");
official_name = CkJsonObjectW_stringOf(jResp,L"official_name");
id_cif = CkJsonObjectW_stringOf(jResp,L"id_cif");
Rfc = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.rfc");
Curp = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.curp");
Name = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.name");
First_last_name = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.first_last_name");
Second_last_name = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.second_last_name");
Start_operations_date = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.start_operations_date");
Status_padron = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.status_padron");
Last_status_change_date = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.last_status_change_date");
Commercial_name = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.commercial_name");
Social_name = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.social_name");
v_Email = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.email");
Phone = CkJsonObjectW_stringOf(jResp,L"tax_payer_information.phone");
Postal_code = CkJsonObjectW_stringOf(jResp,L"address.postal_code");
Street_type = CkJsonObjectW_stringOf(jResp,L"address.street_type");
Street = CkJsonObjectW_stringOf(jResp,L"address.street");
Exterior_number = CkJsonObjectW_stringOf(jResp,L"address.exterior_number");
Interior_number = CkJsonObjectW_stringOf(jResp,L"address.interior_number");
Suburb = CkJsonObjectW_stringOf(jResp,L"address.suburb");
Locality = CkJsonObjectW_stringOf(jResp,L"address.locality");
Municipality = CkJsonObjectW_stringOf(jResp,L"address.municipality");
State = CkJsonObjectW_stringOf(jResp,L"address.state");
Value = CkJsonObjectW_stringOf(jResp,L"address.between_street.value");
Obligation = CkJsonObjectW_stringOf(jResp,L"obligations.obligation");
Expiration = CkJsonObjectW_stringOf(jResp,L"obligations.expiration");
Initial_date = CkJsonObjectW_stringOf(jResp,L"obligations.initial_date");
End_date = CkJsonObjectW_stringOf(jResp,L"obligations.end_date");
personal_information = CkJsonObjectW_stringOf(jResp,L"personal_information");
digital_stamp = CkJsonObjectW_stringOf(jResp,L"digital_stamp");
digital_stamp_chain = CkJsonObjectW_stringOf(jResp,L"digital_stamp_chain");
pdf = CkJsonObjectW_stringOf(jResp,L"pdf");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"economic_activity");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
economic_activityValue = CkJsonObjectW_stringOf(jResp,L"economic_activity[i].economic_activity.value");
end_dateValue = CkJsonObjectW_stringOf(jResp,L"economic_activity[i].end_date.value");
initial_dateValue = CkJsonObjectW_stringOf(jResp,L"economic_activity[i].initial_date.value");
orderValue = CkJsonObjectW_stringOf(jResp,L"economic_activity[i].order.value");
percentageValue = CkJsonObjectW_stringOf(jResp,L"economic_activity[i].percentage.value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"regimens");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
end_dateValue = CkJsonObjectW_stringOf(jResp,L"regimens[i].end_date.value");
initial_dateValue = CkJsonObjectW_stringOf(jResp,L"regimens[i].initial_date.value");
regimenValue = CkJsonObjectW_stringOf(jResp,L"regimens[i].regimen.value");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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]"
}
]
}