Chilkat Online Tools

Swift / Support API / Show Results Count

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 = "login"
    http.Password = "password"

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("query", value: "<string>")

    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://example.zendesk.com/api/v2/search/count", 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>"
    // }

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

    var count: String? = jResp.StringOf("count")

}

Curl Command

curl  -u login:password -G -d "query=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/search/count

Postman Collection Item JSON

{
  "name": "Show Results Count",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/search/count?query=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "search",
        "count"
      ],
      "query": [
        {
          "key": "query",
          "value": "<string>",
          "description": "(Required) The search query"
        }
      ]
    },
    "description": "Returns the number of items matching the query rather than the items. The search string works the same as a regular search.\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/search/count?query=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "search",
            "count"
          ],
          "query": [
            {
              "key": "query",
              "value": "<string>",
              "description": "(Required) The search query"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\"\n}"
    }
  ]
}