Chilkat Online Tools

Swift3 / Belvo API Docs / Detail

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 sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://domain.com/api/owners/:id/", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

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

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

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    // {
    //   "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 value: String?

    var id: String? = jResp.string(of: "id")
    var link: String? = jResp.string(of: "link")
    var collected_at: String? = jResp.string(of: "collected_at")
    var display_name: String? = jResp.string(of: "display_name")
    var first_name: String? = jResp.string(of: "first_name")
    var last_name: String? = jResp.string(of: "last_name")
    var second_last_name: String? = jResp.string(of: "second_last_name")
    var address: String? = jResp.string(of: "address")
    var email: String? = jResp.string(of: "email")
    var phone_number: String? = jResp.string(of: "phone_number")
    var Collected_at: String? = jResp.string(of: "gig_data.collected_at")
    var Status: String? = jResp.string(of: "gig_data.status")
    var Acceptance_rate: String? = jResp.string(of: "gig_data.acceptance_rate")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "accounts").intValue
    while i < count_i {
        jResp.i = i
        value = jResp.string(of: "accounts[i].value")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/owners/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "owners",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `owner.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific owner."
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"display_name\": \"<string>\",\n\t\"first_name\": \"<string>\",\n\t\"last_name\": \"<string>\",\n\t\"second_last_name\": \"<string>\",\n\t\"address\": \"<string>\",\n\t\"email\": \"<email>\",\n\t\"phone_number\": \"<string>\",\n\t\"accounts\": [\n\t\t{\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t{\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t],\n\t\"gig_data\": {\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"status\": \"<string>\",\n\t\t\"acceptance_rate\": \"<number>\"\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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners",
            ":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/owners/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners",
            ":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]"
    }
  ]
}