Chilkat Online Tools

Android / Belvo API Docs / List

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("{{secretId}}");
    http.put_Password("{{secretPassword}}");

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateInt("page",1);

    CkHttpResponse resp = http.QuickRequestParams("GET","https://domain.com/api/links/",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

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

    // {
    //   "count": "<integer>",
    //   "next": "<string>",
    //   "previous": "<string>",
    //   "results": [
    //     {
    //       "id": "<uuid>",
    //       "institution": "<string>",
    //       "access_mode": "<string>",
    //       "last_accessed_at": "<dateTime>",
    //       "status": "<string>",
    //       "created_by": "<uuid>",
    //       "refresh_rate": "<string>"
    //     },
    //     {
    //       "id": "<uuid>",
    //       "institution": "<string>",
    //       "access_mode": "<string>",
    //       "last_accessed_at": "<dateTime>",
    //       "status": "<string>",
    //       "created_by": "<uuid>",
    //       "refresh_rate": "<string>"
    //     }
    //   ]
    // }

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

    String id;
    String institution;
    String access_mode;
    String last_accessed_at;
    String status;
    String created_by;
    String refresh_rate;

    String count = jResp.stringOf("count");
    String v_next = jResp.stringOf("next");
    String previous = jResp.stringOf("previous");
    int i = 0;
    int count_i = jResp.SizeOfArray("results");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("results[i].id");
        institution = jResp.stringOf("results[i].institution");
        access_mode = jResp.stringOf("results[i].access_mode");
        last_accessed_at = jResp.stringOf("results[i].last_accessed_at");
        status = jResp.stringOf("results[i].status");
        created_by = jResp.stringOf("results[i].created_by");
        refresh_rate = jResp.stringOf("results[i].refresh_rate");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/links/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "links",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all the existing links in your Belvo account. 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/links?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links"
          ],
          "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\": \"<uuid>\",\n\t\t\t\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\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/links?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links"
          ],
          "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]"
    }
  ]
}