Chilkat Online Tools

PureBasic / Squadcast API V3 / Get All Services

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"name","")

    CkHttp::ckSetRequestHeader(http,"Authorization","")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.squadcast.com/v3/services",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    id.s
    name.s
    slug.s
    email.s
    escalation_policy_id.s
    organization_id.s
    api_key.s
    description.s
    depends.s
    Id.s
    Name.s
    Description.s
    Slug.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        name = CkJsonObject::ckStringOf(jResp,"data[i].name")
        slug = CkJsonObject::ckStringOf(jResp,"data[i].slug")
        email = CkJsonObject::ckStringOf(jResp,"data[i].email")
        escalation_policy_id = CkJsonObject::ckStringOf(jResp,"data[i].escalation_policy_id")
        organization_id = CkJsonObject::ckStringOf(jResp,"data[i].organization_id")
        api_key = CkJsonObject::ckStringOf(jResp,"data[i].api_key")
        description = CkJsonObject::ckStringOf(jResp,"data[i].description")
        depends = CkJsonObject::ckStringOf(jResp,"data[i].depends")
        Id = CkJsonObject::ckStringOf(jResp,"data[i].escalation_policy.id")
        Name = CkJsonObject::ckStringOf(jResp,"data[i].escalation_policy.name")
        Description = CkJsonObject::ckStringOf(jResp,"data[i].escalation_policy.description")
        Slug = CkJsonObject::ckStringOf(jResp,"data[i].escalation_policy.slug")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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