Chilkat Online Tools

Swift / 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/owners/", 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": "<uuid>",
    //       "link": "<uuid>",
    //       "collected_at": "<dateTime>",
    //       "display_name": "<string>",
    //       "first_name": "<string>",
    //       "last_name": "<string>",
    //       "second_last_name": "<string>",
    //       "address": "<string>",
    //       "email": "<email>",
    //       "phone_number": "<string>",
    //       "accounts": [
    //         {
    //           "value": "<Error: Too many levels of nesting to fake this schema>"
    //         },
    //         {
    //           "value": "<Error: Too many levels of nesting to fake this schema>"
    //         }
    //       ],
    //       "gig_data": {
    //         "collected_at": "<dateTime>",
    //         "status": "<string>",
    //         "acceptance_rate": "<number>"
    //       }
    //     },
    //     {
    //       "id": "<uuid>",
    //       "link": "<uuid>",
    //       "collected_at": "<dateTime>",
    //       "display_name": "<string>",
    //       "first_name": "<string>",
    //       "last_name": "<string>",
    //       "second_last_name": "<string>",
    //       "address": "<string>",
    //       "email": "<email>",
    //       "phone_number": "<string>",
    //       "accounts": [
    //         {
    //           "value": "<Error: Too many levels of nesting to fake this schema>"
    //         },
    //         {
    //           "value": "<Error: Too many levels of nesting to fake this schema>"
    //         }
    //       ],
    //       "gig_data": {
    //         "collected_at": "<dateTime>",
    //         "status": "<string>",
    //         "acceptance_rate": "<number>"
    //       }
    //     }
    //   ]
    // }

    // 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 link: String?
    var collected_at: String?
    var display_name: String?
    var first_name: String?
    var last_name: String?
    var second_last_name: String?
    var address: String?
    var email: String?
    var phone_number: String?
    var Collected_at: String?
    var Status: String?
    var Acceptance_rate: String?
    var j: Int
    var count_j: Int
    var value: String?

    var count: String? = jResp.StringOf("count")
    var v_next: String? = jResp.StringOf("next")
    var previous: String? = jResp.StringOf("previous")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("results").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("results[i].id")
        link = jResp.StringOf("results[i].link")
        collected_at = jResp.StringOf("results[i].collected_at")
        display_name = jResp.StringOf("results[i].display_name")
        first_name = jResp.StringOf("results[i].first_name")
        last_name = jResp.StringOf("results[i].last_name")
        second_last_name = jResp.StringOf("results[i].second_last_name")
        address = jResp.StringOf("results[i].address")
        email = jResp.StringOf("results[i].email")
        phone_number = jResp.StringOf("results[i].phone_number")
        Collected_at = jResp.StringOf("results[i].gig_data.collected_at")
        Status = jResp.StringOf("results[i].gig_data.status")
        Acceptance_rate = jResp.StringOf("results[i].gig_data.acceptance_rate")
        j = 0
        count_j = jResp.SizeOfArray("results[i].accounts").intValue
        while j < count_j {
            jResp.J = j
            value = jResp.StringOf("results[i].accounts[j].value")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/owners/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "owners",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all existing owners 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/owners?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners"
          ],
          "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\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\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/owners?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners"
          ],
          "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]"
    }
  ]
}