Chilkat Online Tools

Swift3 / Belvo API Docs / List

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 queryParams = CkoJsonObject()!
    queryParams.updateInt("page", value: 1)

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/api/institutions/", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

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

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

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "count": "<integer>",
    //   "next": "<string>",
    //   "previous": "<string>",
    //   "results": [
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "type": "culpa dolore in",
    //       "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>"
    //           }
    //         }
    //       ]
    //     },
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "type": "incididunt ut",
    //       "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 id: String?
    var name: String?
    var v_type: String?
    var website: String?
    var display_name: String?
    var primary_color: String?
    var logo: String?
    var icon_logo: String?
    var text_logo: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var Value: String?
    var typeValue: String?
    var labelValue: String?
    var validationValue: String?
    var placeholderValue: String?
    var validation_messageValue: String?
    var valueValue: String?
    var nameValue: String?
    var descriptionValue: String?

    var count: String? = jResp.string(of: "count")
    var v_next: String? = jResp.string(of: "next")
    var previous: String? = jResp.string(of: "previous")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "results").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "results[i].id")
        name = jResp.string(of: "results[i].name")
        v_type = jResp.string(of: "results[i].type")
        website = jResp.string(of: "results[i].website")
        display_name = jResp.string(of: "results[i].display_name")
        primary_color = jResp.string(of: "results[i].primary_color")
        logo = jResp.string(of: "results[i].logo")
        icon_logo = jResp.string(of: "results[i].icon_logo")
        text_logo = jResp.string(of: "results[i].text_logo")
        j = 0
        count_j = jResp.size(ofArray: "results[i].country_codes").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "results[i].country_codes[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "results[i].form_fields").intValue
        while j < count_j {
            jResp.j = j
            Value = jResp.string(of: "results[i].form_fields[j].name.value")
            typeValue = jResp.string(of: "results[i].form_fields[j].type.value")
            labelValue = jResp.string(of: "results[i].form_fields[j].label.value")
            validationValue = jResp.string(of: "results[i].form_fields[j].validation.value")
            placeholderValue = jResp.string(of: "results[i].form_fields[j].placeholder.value")
            validation_messageValue = jResp.string(of: "results[i].form_fields[j].validation_message.value")
            valueValue = jResp.string(of: "results[i].form_fields[j].value.value")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "results[i].features").intValue
        while j < count_j {
            jResp.j = j
            nameValue = jResp.string(of: "results[i].features[j].name.value")
            descriptionValue = jResp.string(of: "results[i].features[j].description.value")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -G -d "page=1"
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/institutions/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/institutions/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "institutions",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all the institutions currently supported by Belvo. We return up to 100 results per page."
  },
  "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?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<string>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"type\": \"culpa dolore in\",\n\t\t\t\"website\": \"<string>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"country_codes\": [\n\t\t\t\t\"<string>\",\n\t\t\t\t\"<string>\"\n\t\t\t],\n\t\t\t\"primary_color\": \"<string>\",\n\t\t\t\"logo\": \"<string>\",\n\t\t\t\"icon_logo\": \"<string>\",\n\t\t\t\"text_logo\": \"<string>\",\n\t\t\t\"form_fields\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\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\"type\": {\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\"label\": {\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\"validation\": {\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\"placeholder\": {\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\"validation_message\": {\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\"value\": {\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{\n\t\t\t\t\t\"name\": {\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\"type\": {\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\"label\": {\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\"validation\": {\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\"placeholder\": {\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\"validation_message\": {\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\"value\": {\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],\n\t\t\t\"features\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\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\"description\": {\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{\n\t\t\t\t\t\"name\": {\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\"description\": {\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]\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<string>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"type\": \"incididunt ut\",\n\t\t\t\"website\": \"<string>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"country_codes\": [\n\t\t\t\t\"<string>\",\n\t\t\t\t\"<string>\"\n\t\t\t],\n\t\t\t\"primary_color\": \"<string>\",\n\t\t\t\"logo\": \"<string>\",\n\t\t\t\"icon_logo\": \"<string>\",\n\t\t\t\"text_logo\": \"<string>\",\n\t\t\t\"form_fields\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\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\"type\": {\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\"label\": {\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\"validation\": {\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\"placeholder\": {\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\"validation_message\": {\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\"value\": {\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{\n\t\t\t\t\t\"name\": {\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\"type\": {\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\"label\": {\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\"validation\": {\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\"placeholder\": {\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\"validation_message\": {\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\"value\": {\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],\n\t\t\t\"features\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\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\"description\": {\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{\n\t\t\t\t\t\"name\": {\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\"description\": {\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]\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?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "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]"
    }
  ]
}