Chilkat Online Tools

Powershell / Belvo API Docs / Detail

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "{{secretId}}"
$http.Password = "{{secretPassword}}"

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/api/incomes/:id/",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jarrResp = New-Object Chilkat.JsonArray
$jarrResp.LoadSb($sbResponseBody)
$jarrResp.EmitCompact = $false

$("Response Body:")
$($jarrResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# [
#   {
#     "id": "<uuid>",
#     "collected_at": "<dateTime>",
#     "account": {
#       "name": "<string>",
#       "currency": "<string>",
#       "category": "adipisicing pariatur sit"
#     },
#     "currency": "<string>",
#     "sources": [
#       {
#         "transactions": [
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           },
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           }
#         ],
#         "confidence": "<string>",
#         "type": "<string>"
#       },
#       {
#         "transactions": [
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           },
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           }
#         ],
#         "confidence": "<string>",
#         "type": "<string>"
#       }
#     ]
#   },
#   {
#     "id": "<uuid>",
#     "collected_at": "<dateTime>",
#     "account": {
#       "name": "<string>",
#       "currency": "<string>",
#       "category": "exercitation consequat"
#     },
#     "currency": "<string>",
#     "sources": [
#       {
#         "transactions": [
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           },
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           }
#         ],
#         "confidence": "<string>",
#         "type": "<string>"
#       },
#       {
#         "transactions": [
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           },
#           {
#             "value": "<Error: Too many levels of nesting to fake this schema>"
#           }
#         ],
#         "confidence": "<string>",
#         "type": "<string>"
#       }
#     ]
#   }
# ]

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0
$count_i = $jarrResp.Size
while ($i -lt $count_i) {
    $json = $jarrResp.ObjectAt($i)
    $id = $json.StringOf("id")
    $collected_at = $json.StringOf("collected_at")
    $Name = $json.StringOf("account.name")
    $v_Currency = $json.StringOf("account.currency")
    $Category = $json.StringOf("account.category")
    $v_currency = $json.StringOf("currency")
    $j = 0
    $count_j = $json.SizeOfArray("sources")
    while ($j -lt $count_j) {
        $json.J = $j
        $confidence = $json.StringOf("sources[j].confidence")
        $v_type = $json.StringOf("sources[j].type")
        $k = 0
        $count_k = $json.SizeOfArray("sources[j].transactions")
        while ($k -lt $count_k) {
            $json.K = $k
            $value = $json.StringOf("sources[j].transactions[k].value")
            $k = $k + 1
        }

        $j = $j + 1
    }

    $i = $i + 1
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/incomes/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "incomes",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `income.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific income."
  },
  "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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"adipisicing pariatur sit\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"exercitation consequat\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":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]"
    }
  ]
}