Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcEconomic_activityValue
LOCAL lcEnd_dateValue
LOCAL lcInitial_dateValue
LOCAL lcOrderValue
LOCAL lcPercentageValue
LOCAL lcRegimenValue
LOCAL lcId
LOCAL lcLink
LOCAL lcCollected_at
LOCAL lcPlace_and_date_of_issuance
LOCAL lcOfficial_name
LOCAL lcId_cif
LOCAL lcRfc
LOCAL lcCurp
LOCAL lcName
LOCAL lcFirst_last_name
LOCAL lcSecond_last_name
LOCAL lcStart_operations_date
LOCAL lcStatus_padron
LOCAL lcLast_status_change_date
LOCAL lcCommercial_name
LOCAL lcSocial_name
LOCAL lcV_Email
LOCAL lcPhone
LOCAL lcPostal_code
LOCAL lcStreet_type
LOCAL lcStreet
LOCAL lcExterior_number
LOCAL lcInterior_number
LOCAL lcSuburb
LOCAL lcLocality
LOCAL lcMunicipality
LOCAL lcState
LOCAL lcValue
LOCAL lcObligation
LOCAL lcExpiration
LOCAL lcInitial_date
LOCAL lcEnd_date
LOCAL lcPersonal_information
LOCAL lcDigital_stamp
LOCAL lcDigital_stamp_chain
LOCAL lcPdf
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/api/tax-status/:id/",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcId = loJResp.StringOf("id")
lcLink = loJResp.StringOf("link")
lcCollected_at = loJResp.StringOf("collected_at")
lcPlace_and_date_of_issuance = loJResp.StringOf("place_and_date_of_issuance")
lcOfficial_name = loJResp.StringOf("official_name")
lcId_cif = loJResp.StringOf("id_cif")
lcRfc = loJResp.StringOf("tax_payer_information.rfc")
lcCurp = loJResp.StringOf("tax_payer_information.curp")
lcName = loJResp.StringOf("tax_payer_information.name")
lcFirst_last_name = loJResp.StringOf("tax_payer_information.first_last_name")
lcSecond_last_name = loJResp.StringOf("tax_payer_information.second_last_name")
lcStart_operations_date = loJResp.StringOf("tax_payer_information.start_operations_date")
lcStatus_padron = loJResp.StringOf("tax_payer_information.status_padron")
lcLast_status_change_date = loJResp.StringOf("tax_payer_information.last_status_change_date")
lcCommercial_name = loJResp.StringOf("tax_payer_information.commercial_name")
lcSocial_name = loJResp.StringOf("tax_payer_information.social_name")
lcV_Email = loJResp.StringOf("tax_payer_information.email")
lcPhone = loJResp.StringOf("tax_payer_information.phone")
lcPostal_code = loJResp.StringOf("address.postal_code")
lcStreet_type = loJResp.StringOf("address.street_type")
lcStreet = loJResp.StringOf("address.street")
lcExterior_number = loJResp.StringOf("address.exterior_number")
lcInterior_number = loJResp.StringOf("address.interior_number")
lcSuburb = loJResp.StringOf("address.suburb")
lcLocality = loJResp.StringOf("address.locality")
lcMunicipality = loJResp.StringOf("address.municipality")
lcState = loJResp.StringOf("address.state")
lcValue = loJResp.StringOf("address.between_street.value")
lcObligation = loJResp.StringOf("obligations.obligation")
lcExpiration = loJResp.StringOf("obligations.expiration")
lcInitial_date = loJResp.StringOf("obligations.initial_date")
lcEnd_date = loJResp.StringOf("obligations.end_date")
lcPersonal_information = loJResp.StringOf("personal_information")
lcDigital_stamp = loJResp.StringOf("digital_stamp")
lcDigital_stamp_chain = loJResp.StringOf("digital_stamp_chain")
lcPdf = loJResp.StringOf("pdf")
i = 0
lnCount_i = loJResp.SizeOfArray("economic_activity")
DO WHILE i < lnCount_i
loJResp.I = i
lcEconomic_activityValue = loJResp.StringOf("economic_activity[i].economic_activity.value")
lcEnd_dateValue = loJResp.StringOf("economic_activity[i].end_date.value")
lcInitial_dateValue = loJResp.StringOf("economic_activity[i].initial_date.value")
lcOrderValue = loJResp.StringOf("economic_activity[i].order.value")
lcPercentageValue = loJResp.StringOf("economic_activity[i].percentage.value")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("regimens")
DO WHILE i < lnCount_i
loJResp.I = i
lcEnd_dateValue = loJResp.StringOf("regimens[i].end_date.value")
lcInitial_dateValue = loJResp.StringOf("regimens[i].initial_date.value")
lcRegimenValue = loJResp.StringOf("regimens[i].regimen.value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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]"
}
]
}
