Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/tax-status/:id/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sEconomic_activityValue
Local $sEnd_dateValue
Local $sInitial_dateValue
Local $sOrderValue
Local $sPercentageValue
Local $sRegimenValue
Local $sId = $oJResp.StringOf("id")
Local $sLink = $oJResp.StringOf("link")
Local $sCollected_at = $oJResp.StringOf("collected_at")
Local $sPlace_and_date_of_issuance = $oJResp.StringOf("place_and_date_of_issuance")
Local $sOfficial_name = $oJResp.StringOf("official_name")
Local $sId_cif = $oJResp.StringOf("id_cif")
Local $sRfc = $oJResp.StringOf("tax_payer_information.rfc")
Local $sCurp = $oJResp.StringOf("tax_payer_information.curp")
Local $sName = $oJResp.StringOf("tax_payer_information.name")
Local $sFirst_last_name = $oJResp.StringOf("tax_payer_information.first_last_name")
Local $sSecond_last_name = $oJResp.StringOf("tax_payer_information.second_last_name")
Local $sStart_operations_date = $oJResp.StringOf("tax_payer_information.start_operations_date")
Local $sStatus_padron = $oJResp.StringOf("tax_payer_information.status_padron")
Local $sLast_status_change_date = $oJResp.StringOf("tax_payer_information.last_status_change_date")
Local $sCommercial_name = $oJResp.StringOf("tax_payer_information.commercial_name")
Local $sSocial_name = $oJResp.StringOf("tax_payer_information.social_name")
Local $sV_Email = $oJResp.StringOf("tax_payer_information.email")
Local $sPhone = $oJResp.StringOf("tax_payer_information.phone")
Local $sPostal_code = $oJResp.StringOf("address.postal_code")
Local $sStreet_type = $oJResp.StringOf("address.street_type")
Local $sStreet = $oJResp.StringOf("address.street")
Local $sExterior_number = $oJResp.StringOf("address.exterior_number")
Local $sInterior_number = $oJResp.StringOf("address.interior_number")
Local $sSuburb = $oJResp.StringOf("address.suburb")
Local $sLocality = $oJResp.StringOf("address.locality")
Local $sMunicipality = $oJResp.StringOf("address.municipality")
Local $sState = $oJResp.StringOf("address.state")
Local $sValue = $oJResp.StringOf("address.between_street.value")
Local $sObligation = $oJResp.StringOf("obligations.obligation")
Local $sExpiration = $oJResp.StringOf("obligations.expiration")
Local $sInitial_date = $oJResp.StringOf("obligations.initial_date")
Local $sEnd_date = $oJResp.StringOf("obligations.end_date")
Local $sPersonal_information = $oJResp.StringOf("personal_information")
Local $sDigital_stamp = $oJResp.StringOf("digital_stamp")
Local $sDigital_stamp_chain = $oJResp.StringOf("digital_stamp_chain")
Local $sPdf = $oJResp.StringOf("pdf")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("economic_activity")
While $i < $iCount_i
$oJResp.I = $i
$sEconomic_activityValue = $oJResp.StringOf("economic_activity[i].economic_activity.value")
$sEnd_dateValue = $oJResp.StringOf("economic_activity[i].end_date.value")
$sInitial_dateValue = $oJResp.StringOf("economic_activity[i].initial_date.value")
$sOrderValue = $oJResp.StringOf("economic_activity[i].order.value")
$sPercentageValue = $oJResp.StringOf("economic_activity[i].percentage.value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("regimens")
While $i < $iCount_i
$oJResp.I = $i
$sEnd_dateValue = $oJResp.StringOf("regimens[i].end_date.value")
$sInitial_dateValue = $oJResp.StringOf("regimens[i].initial_date.value")
$sRegimenValue = $oJResp.StringOf("regimens[i].regimen.value")
$i = $i + 1
Wend
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]"
}
]
}
