Chilkat Online Tools

VB6 / Squadcast API V3 / Get All Services

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("name","")

http.SetRequestHeader "Authorization",""

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.squadcast.com/v3/services",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim id As String
Dim name As String
Dim slug As String
Dim email As String
Dim escalation_policy_id As String
Dim organization_id As String
Dim api_key As String
Dim description As String
Dim depends As String
Dim Id As String
Dim Name As String
Dim Description As String
Dim Slug As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do While i < count_i
    jResp.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
Loop

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