Chilkat Online Tools

Foxpro / Belvo API Docs / Detail

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcValue
LOCAL lcInstitutionValue
LOCAL lcCollected_atValue
LOCAL lcCategoryValue
LOCAL lcTypeValue
LOCAL lcNameValue
LOCAL lcNumberValue
LOCAL lcBalanceValue
LOCAL lcCurrencyValue
LOCAL lcBank_product_idValue
LOCAL lcInternal_identificationValue
LOCAL lcPublic_identification_nameValue
LOCAL lcPublic_identification_valueValue
LOCAL lcLast_accessed_atValue
LOCAL lcCredit_dataValue
LOCAL lcLoan_dataValue
LOCAL lcFunds_dataValue
LOCAL lcGig_payment_dataValue

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/api/accounts/:id/",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.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": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "institution": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "collected_at": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "category": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "type": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "name": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "number": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "balance": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "currency": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "bank_product_id": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "internal_identification": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "public_identification_name": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "public_identification_value": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "last_accessed_at": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "credit_data": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "loan_data": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "funds_data": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   },
*   "gig_payment_data": {
*     "value": "<Error: Too many levels of nesting to fake this schema>"
*   }
* }

* 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")
lcValue = loJResp.StringOf("link.value")
lcInstitutionValue = loJResp.StringOf("institution.value")
lcCollected_atValue = loJResp.StringOf("collected_at.value")
lcCategoryValue = loJResp.StringOf("category.value")
lcTypeValue = loJResp.StringOf("type.value")
lcNameValue = loJResp.StringOf("name.value")
lcNumberValue = loJResp.StringOf("number.value")
lcBalanceValue = loJResp.StringOf("balance.value")
lcCurrencyValue = loJResp.StringOf("currency.value")
lcBank_product_idValue = loJResp.StringOf("bank_product_id.value")
lcInternal_identificationValue = loJResp.StringOf("internal_identification.value")
lcPublic_identification_nameValue = loJResp.StringOf("public_identification_name.value")
lcPublic_identification_valueValue = loJResp.StringOf("public_identification_value.value")
lcLast_accessed_atValue = loJResp.StringOf("last_accessed_at.value")
lcCredit_dataValue = loJResp.StringOf("credit_data.value")
lcLoan_dataValue = loJResp.StringOf("loan_data.value")
lcFunds_dataValue = loJResp.StringOf("funds_data.value")
lcGig_payment_dataValue = loJResp.StringOf("gig_payment_data.value")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/accounts/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/accounts/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "accounts",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `account.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific account."
  },
  "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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"institution\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"collected_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"category\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"type\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"number\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"balance\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"currency\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"bank_product_id\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"internal_identification\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_value\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"last_accessed_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"credit_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"loan_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"funds_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"gig_payment_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t}\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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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]"
    }
  ]
}