Chilkat Online Tools

Go / Belvo API Docs / Detail

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("{{secretId}}")
    http.SetPassword("{{secretPassword}}")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/api/institutions/:id/",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

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

    // {
    //   "id": "<string>",
    //   "name": "<string>",
    //   "type": "nulla Excepteur nisi",
    //   "website": "<string>",
    //   "display_name": "<string>",
    //   "country_codes": [
    //     "<string>",
    //     "<string>"
    //   ],
    //   "primary_color": "<string>",
    //   "logo": "<string>",
    //   "icon_logo": "<string>",
    //   "text_logo": "<string>",
    //   "form_fields": [
    //     {
    //       "name": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "type": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "label": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "validation": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "placeholder": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "validation_message": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "value": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       }
    //     },
    //     {
    //       "name": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "type": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "label": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "validation": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "placeholder": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "validation_message": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "value": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       }
    //     }
    //   ],
    //   "features": [
    //     {
    //       "name": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "description": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       }
    //     },
    //     {
    //       "name": {
    //         "value": "<Error: Too many levels of nesting to fake this schema>"
    //       },
    //       "description": {
    //         "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

    var strVal *string = new(string)
    var Value *string = new(string)
    var typeValue *string = new(string)
    var labelValue *string = new(string)
    var validationValue *string = new(string)
placeholder    var Value *string = new(string)
    var validation_messageValue *string = new(string)
value    var Value *string = new(string)
    var nameValue *string = new(string)
    var descriptionValue *string = new(string)

    id := jResp.StringOf("id")
    name := jResp.StringOf("name")
    v_type := jResp.StringOf("type")
    website := jResp.StringOf("website")
    display_name := jResp.StringOf("display_name")
    primary_color := jResp.StringOf("primary_color")
    logo := jResp.StringOf("logo")
    icon_logo := jResp.StringOf("icon_logo")
    text_logo := jResp.StringOf("text_logo")
    i := 0
    count_i := jResp.SizeOfArray("country_codes")
    for i < count_i {
        jResp.SetI(i)
        strVal = jResp.StringOf("country_codes[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("form_fields")
    for i < count_i {
        jResp.SetI(i)
        Value = jResp.StringOf("form_fields[i].name.value")
        typeValue = jResp.StringOf("form_fields[i].type.value")
        labelValue = jResp.StringOf("form_fields[i].label.value")
        validationValue = jResp.StringOf("form_fields[i].validation.value")
        placeholderValue = jResp.StringOf("form_fields[i].placeholder.value")
        validation_messageValue = jResp.StringOf("form_fields[i].validation_message.value")
        valueValue = jResp.StringOf("form_fields[i].value.value")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("features")
    for i < count_i {
        jResp.SetI(i)
        nameValue = jResp.StringOf("features[i].name.value")
        descriptionValue = jResp.StringOf("features[i].description.value")
        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/institutions/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "institutions",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `institution.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific institution."
  },
  "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/institutions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<string>\",\n\t\"name\": \"<string>\",\n\t\"type\": \"nulla Excepteur nisi\",\n\t\"website\": \"<string>\",\n\t\"display_name\": \"<string>\",\n\t\"country_codes\": [\n\t\t\"<string>\",\n\t\t\"<string>\"\n\t],\n\t\"primary_color\": \"<string>\",\n\t\"logo\": \"<string>\",\n\t\"icon_logo\": \"<string>\",\n\t\"text_logo\": \"<string>\",\n\t\"form_fields\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\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\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\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\"features\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\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\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\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}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/institutions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":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/institutions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":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]"
    }
  ]
}