Chilkat Online Tools

Swift3 / Belvo API Docs / Detail

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{secretId}}"
    http.password = "{{secretPassword}}"

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://domain.com/api/tax-status/:id/", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        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

    var economic_activityValue: String?
    var end_dateValue: String?
    var initial_dateValue: String?
    var orderValue: String?
    var percentageValue: String?
    var regimenValue: String?

    var id: String? = jResp.string(of: "id")
    var link: String? = jResp.string(of: "link")
    var collected_at: String? = jResp.string(of: "collected_at")
    var place_and_date_of_issuance: String? = jResp.string(of: "place_and_date_of_issuance")
    var official_name: String? = jResp.string(of: "official_name")
    var id_cif: String? = jResp.string(of: "id_cif")
    var Rfc: String? = jResp.string(of: "tax_payer_information.rfc")
    var Curp: String? = jResp.string(of: "tax_payer_information.curp")
    var Name: String? = jResp.string(of: "tax_payer_information.name")
    var First_last_name: String? = jResp.string(of: "tax_payer_information.first_last_name")
    var Second_last_name: String? = jResp.string(of: "tax_payer_information.second_last_name")
    var Start_operations_date: String? = jResp.string(of: "tax_payer_information.start_operations_date")
    var Status_padron: String? = jResp.string(of: "tax_payer_information.status_padron")
    var Last_status_change_date: String? = jResp.string(of: "tax_payer_information.last_status_change_date")
    var Commercial_name: String? = jResp.string(of: "tax_payer_information.commercial_name")
    var Social_name: String? = jResp.string(of: "tax_payer_information.social_name")
    var v_Email: String? = jResp.string(of: "tax_payer_information.email")
    var Phone: String? = jResp.string(of: "tax_payer_information.phone")
    var Postal_code: String? = jResp.string(of: "address.postal_code")
    var Street_type: String? = jResp.string(of: "address.street_type")
    var Street: String? = jResp.string(of: "address.street")
    var Exterior_number: String? = jResp.string(of: "address.exterior_number")
    var Interior_number: String? = jResp.string(of: "address.interior_number")
    var Suburb: String? = jResp.string(of: "address.suburb")
    var Locality: String? = jResp.string(of: "address.locality")
    var Municipality: String? = jResp.string(of: "address.municipality")
    var State: String? = jResp.string(of: "address.state")
    var Value: String? = jResp.string(of: "address.between_street.value")
    var Obligation: String? = jResp.string(of: "obligations.obligation")
    var Expiration: String? = jResp.string(of: "obligations.expiration")
    var Initial_date: String? = jResp.string(of: "obligations.initial_date")
    var End_date: String? = jResp.string(of: "obligations.end_date")
    var personal_information: String? = jResp.string(of: "personal_information")
    var digital_stamp: String? = jResp.string(of: "digital_stamp")
    var digital_stamp_chain: String? = jResp.string(of: "digital_stamp_chain")
    var pdf: String? = jResp.string(of: "pdf")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "economic_activity").intValue
    while i < count_i {
        jResp.i = i
        economic_activityValue = jResp.string(of: "economic_activity[i].economic_activity.value")
        end_dateValue = jResp.string(of: "economic_activity[i].end_date.value")
        initial_dateValue = jResp.string(of: "economic_activity[i].initial_date.value")
        orderValue = jResp.string(of: "economic_activity[i].order.value")
        percentageValue = jResp.string(of: "economic_activity[i].percentage.value")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "regimens").intValue
    while i < count_i {
        jResp.i = i
        end_dateValue = jResp.string(of: "regimens[i].end_date.value")
        initial_dateValue = jResp.string(of: "regimens[i].initial_date.value")
        regimenValue = jResp.string(of: "regimens[i].regimen.value")
        i = i + 1
    }


}

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]"
    }
  ]
}