Lua

SCIS Health Check

See more SCiS Schools Catalogue Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

-- 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.basic_auth = true

local sbResponseBody = chilkat.StringBuilder.new()
local success = http:quick_get_sb("https://api.scisdata.com/checkStatus", sbResponseBody)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = http.last_status
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(http.last_header)
    print("Failed.")
    return
end

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