Chilkat Online Tools

autoit / 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.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("name","")

$oHttp.SetRequestHeader "Authorization",""

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.squadcast.com/v3/services",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sId
Local $sName
Local $slug
Local $sEmail
Local $sEscalation_policy_id
Local $sOrganization_id
Local $sApi_key
Local $sDescription
Local $sDepends
Local $sId
Local $sName
Local $sDescription
Local $sSlug

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("data[i].id")
    $sName = $oJResp.StringOf("data[i].name")
    $slug = $oJResp.StringOf("data[i].slug")
    $sEmail = $oJResp.StringOf("data[i].email")
    $sEscalation_policy_id = $oJResp.StringOf("data[i].escalation_policy_id")
    $sOrganization_id = $oJResp.StringOf("data[i].organization_id")
    $sApi_key = $oJResp.StringOf("data[i].api_key")
    $sDescription = $oJResp.StringOf("data[i].description")
    $sDepends = $oJResp.StringOf("data[i].depends")
    $sId = $oJResp.StringOf("data[i].escalation_policy.id")
    $sName = $oJResp.StringOf("data[i].escalation_policy.name")
    $sDescription = $oJResp.StringOf("data[i].escalation_policy.description")
    $sSlug = $oJResp.StringOf("data[i].escalation_policy.slug")
    $i = $i + 1
Wend

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