Chilkat Online Tools

VB6 / Squadcast API V3 / Create Service

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

' Use this online tool to generate code from sample JSON: Generate Code to Create JSON

' The following JSON is sent in the request body.

' {
'   "name": "<string>",
'   "description": "<string>",
'   "escalation_policy_id": "<string>",
'   "email_prefix": "<string>"
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("name","<string>")
success = json.UpdateString("description","<string>")
success = json.UpdateString("escalation_policy_id","<string>")
success = json.UpdateString("email_prefix","<string>")

http.SetRequestHeader "Authorization",""
http.SetRequestHeader "Content-Type","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.squadcast.com/v3/services","application/json",json)
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"
'     }
'   }
' }

' 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
Id = jResp.StringOf("data.id")
Dim Name As String
Name = jResp.StringOf("data.name")
Dim Slug As String
Slug = jResp.StringOf("data.slug")
Dim v_Email As String
v_Email = jResp.StringOf("data.email")
Dim Escalation_policy_id As String
Escalation_policy_id = jResp.StringOf("data.escalation_policy_id")
Dim Organization_id As String
Organization_id = jResp.StringOf("data.organization_id")
Dim Api_key As String
Api_key = jResp.StringOf("data.api_key")
Dim Description As String
Description = jResp.StringOf("data.description")
Dim Depends As String
Depends = jResp.StringOf("data.depends")
Dim Escalation_policyId As String
Escalation_policyId = jResp.StringOf("data.escalation_policy.id")
Dim Escalation_policyName As String
Escalation_policyName = jResp.StringOf("data.escalation_policy.name")
Dim Escalation_policyDescription As String
Escalation_policyDescription = jResp.StringOf("data.escalation_policy.description")
Dim Escalation_policySlug As String
Escalation_policySlug = jResp.StringOf("data.escalation_policy.slug")

Curl Command

curl -X POST
	-H "Authorization: "
	-H "Content-Type: application/json"
	-d '{
    "name": "<string>",
    "description": "<string>",
    "escalation_policy_id": "<string>",
    "email_prefix": "<string>"
}'
https://api.squadcast.com/v3/services

Postman Collection Item JSON

{
  "name": "Create Service",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"escalation_policy_id\": \"<string>\",\n    \"email_prefix\": \"<string>\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/services",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services"
      ]
    },
    "description": "This endpoint is used to create a service.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `service-write` scope.\n"
  },
  "response": [
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\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}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"auxpkg create 1\",\n    \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n    \"description\": \"service api\",\n    \"email_prefix\": \"\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Payment Required",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": ""
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"escalation_policy_id\": \"<string>\",\n    \"email_prefix\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ]
        }
      },
      "status": "Payment Required",
      "code": 402,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n\t\"meta\": {\n\t\t\"status\": 402,\n\t\t\"error_message\": \"organization has crossed the plan limits for 'service'\",\n\t\t\"error_details\": {\n\t\t\t\"code\": \"E0402\",\n\t\t\t\"description\": \"You've exceeded the number of services under your current plan. To continue, please upgrade.\",\n\t\t\t\"link\": \"https://support.squadcast.com/docs/error-codes-and-what-they-mean\"\n\t\t}\n\t}\n}"
    }
  ]
}