PowerShell

SCIS Health Check

See more SCiS Schools Catalogue Examples

Demonstrates the SCIS (Schools Catalogue Information Service) health check API call. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl -i -X GET --url https://api.scisdata.com/checkStatus -H 'Authorization: Basic ****'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# This causes the "Authorization: Basic ****" to be added to each request.
$http.Login = "myLogin"
$http.Password = "myPassword"
$http.BasicAuth = $true

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.scisdata.com/checkStatus",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# 
# {
#   "subscriptionStatus": {
#     "messages": [
#       "Connection to SCIS API is successful",
#       "User has a valid SCIS Data subscription"
#     ]
#   }
# }