Chilkat Online Tools

C++ / Squadcast API V3 / Get All Services

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("name","");

    http.SetRequestHeader("Authorization","");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.squadcast.com/v3/services",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "data": [
    //     {
    //       "id": "5e8edb24668e003cb0b18ba1",
    //       "name": "Payment API Service",
    //       "slug": "payment-api-service",
    //       "email": "unique_string@gopherhut.incidents.squadcast.com",
    //       "escalation_policy_id": "5d81d9407000fb6b9def7e33",
    //       "organization_id": "5d81d9187000fb6b9def7e32",
    //       "api_key": "2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43",
    //       "description": "Payment API Service monitor",
    //       "depends": null,
    //       "escalation_policy": {
    //         "id": "5d81d9407000fb6b9def7e33",
    //         "name": "Example Escalation Policy",
    //         "description": "On-Boarding Example",
    //         "slug": "example-escalation-policy"
    //       }
    //     },
    //     {
    //       "id": "5e8edb24668e003cb0b18ba2",
    //       "name": "Notification Service",
    //       "slug": "notification-api-service",
    //       "email": "unique_string@gopherhut.incidents.squadcast.com",
    //       "escalation_policy_id": "5d81d9407000fb6b9def7e33",
    //       "organization_id": "5d81d9187000fb6b9def7e32",
    //       "api_key": "2f81ac8b2362990dd220f8bb4f7cd30ccc3d43",
    //       "description": "Notification API Service monitor",
    //       "depends": null,
    //       "escalation_policy": {
    //         "id": "5d81d9407000fb6b9def7e33",
    //         "name": "Example Escalation Policy",
    //         "description": "On-Boarding Example",
    //         "slug": "example-escalation-policy"
    //       }
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *name = 0;
    const char *slug = 0;
    const char *email = 0;
    const char *escalation_policy_id = 0;
    const char *organization_id = 0;
    const char *api_key = 0;
    const char *description = 0;
    const char *depends = 0;
    const char *Id = 0;
    const char *Name = 0;
    const char *Description = 0;
    const char *Slug = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data[i].id");
        name = jResp.stringOf("data[i].name");
        slug = jResp.stringOf("data[i].slug");
        email = jResp.stringOf("data[i].email");
        escalation_policy_id = jResp.stringOf("data[i].escalation_policy_id");
        organization_id = jResp.stringOf("data[i].organization_id");
        api_key = jResp.stringOf("data[i].api_key");
        description = jResp.stringOf("data[i].description");
        depends = jResp.stringOf("data[i].depends");
        Id = jResp.stringOf("data[i].escalation_policy.id");
        Name = jResp.stringOf("data[i].escalation_policy.name");
        Description = jResp.stringOf("data[i].escalation_policy.description");
        Slug = jResp.stringOf("data[i].escalation_policy.slug");
        i = i + 1;
    }
    }

Curl Command

curl -G -d "name="
	-H "Authorization: "
https://api.squadcast.com/v3/services

Postman Collection Item JSON

{
  "name": "Get All Services",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/services?name=",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services"
      ],
      "query": [
        {
          "key": "name",
          "value": ""
        }
      ]
    },
    "description": "Returns all the active services for the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope.\n\nQuery Param:\n\n`name`: get a service by name"
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": [\n  {\n   \"id\": \"5e8edb24668e003cb0b18ba1\",\n   \"name\": \"Payment API Service\",\n   \"slug\": \"payment-api-service\",\n   \"email\": \"unique_string@gopherhut.incidents.squadcast.com\",\n   \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n   \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n   \"api_key\": \"2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43\",\n   \"description\": \"Payment API Service monitor\",\n   \"depends\": null,\n   \"escalation_policy\": {\n    \"id\": \"5d81d9407000fb6b9def7e33\",\n    \"name\": \"Example Escalation Policy\",\n    \"description\": \"On-Boarding Example\",\n    \"slug\": \"example-escalation-policy\"\n   }\n  },\n  {\n   \"id\": \"5e8edb24668e003cb0b18ba2\",\n   \"name\": \"Notification Service\",\n   \"slug\": \"notification-api-service\",\n   \"email\": \"unique_string@gopherhut.incidents.squadcast.com\",\n   \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n   \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n   \"api_key\": \"2f81ac8b2362990dd220f8bb4f7cd30ccc3d43\",\n   \"description\": \"Notification API Service monitor\",\n   \"depends\": null,\n   \"escalation_policy\": {\n    \"id\": \"5d81d9407000fb6b9def7e33\",\n    \"name\": \"Example Escalation Policy\",\n    \"description\": \"On-Boarding Example\",\n    \"slug\": \"example-escalation-policy\"\n   }\n  }\n ]\n}"
    }
  ]
}