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 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/owners/: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": "<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 = new(string)

    id := jResp.StringOf("id")
    link := jResp.StringOf("link")
    collected_at := jResp.StringOf("collected_at")
    display_name := jResp.StringOf("display_name")
    first_name := jResp.StringOf("first_name")
    last_name := jResp.StringOf("last_name")
    second_last_name := jResp.StringOf("second_last_name")
    address := jResp.StringOf("address")
    email := jResp.StringOf("email")
    phone_number := jResp.StringOf("phone_number")
    Collected_at := jResp.StringOf("gig_data.collected_at")
    Status := jResp.StringOf("gig_data.status")
    Acceptance_rate := jResp.StringOf("gig_data.acceptance_rate")
    i := 0
    count_i := jResp.SizeOfArray("accounts")
    for i < count_i {
        jResp.SetI(i)
        value = jResp.StringOf("accounts[i].value")
        i = i + 1
    }


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

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]"
    }
  ]
}