Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'username'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "app": {
-- "id": "5d8cff3cd55b040010928b5b",
-- "displayName": "utoc",
-- "settings": {
-- "conversationRetentionSeconds": 35855812,
-- "maskCreditCardNumbers": true,
-- "useAnimalNames": false,
-- "echoPostback": true,
-- "ignoreAutoConversationStart": true,
-- "multiConvoEnabled": true,
-- "attachmentsAccess": "public",
-- "attachmentsTokenExpirationSeconds": 64028
-- },
-- "metadata": {
-- "lang": "en-ca"
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'app.id'
DECLARE @DisplayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DisplayName OUT, 'app.displayName'
DECLARE @ConversationRetentionSeconds int
EXEC sp_OAMethod @jResp, 'IntOf', @ConversationRetentionSeconds OUT, 'app.settings.conversationRetentionSeconds'
DECLARE @MaskCreditCardNumbers int
EXEC sp_OAMethod @jResp, 'BoolOf', @MaskCreditCardNumbers OUT, 'app.settings.maskCreditCardNumbers'
DECLARE @UseAnimalNames int
EXEC sp_OAMethod @jResp, 'BoolOf', @UseAnimalNames OUT, 'app.settings.useAnimalNames'
DECLARE @EchoPostback int
EXEC sp_OAMethod @jResp, 'BoolOf', @EchoPostback OUT, 'app.settings.echoPostback'
DECLARE @IgnoreAutoConversationStart int
EXEC sp_OAMethod @jResp, 'BoolOf', @IgnoreAutoConversationStart OUT, 'app.settings.ignoreAutoConversationStart'
DECLARE @MultiConvoEnabled int
EXEC sp_OAMethod @jResp, 'BoolOf', @MultiConvoEnabled OUT, 'app.settings.multiConvoEnabled'
DECLARE @AttachmentsAccess nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AttachmentsAccess OUT, 'app.settings.attachmentsAccess'
DECLARE @AttachmentsTokenExpirationSeconds int
EXEC sp_OAMethod @jResp, 'IntOf', @AttachmentsTokenExpirationSeconds OUT, 'app.settings.attachmentsTokenExpirationSeconds'
DECLARE @Lang nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Lang OUT, 'app.metadata.lang'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-u 'username:password'
https://domain.com/
Postman Collection Item JSON
{
"name": "Get App",
"_postman_id": "b6b38388-b3be-454f-aca6-f0624470ea02",
"request": {
"method": "GET",
"header": [
],
"url": "{{url}}/v2/apps/{{appId}}",
"description": "Fetches an individual app."
},
"response": [
{
"id": "12c94751-e245-4540-8c81-865dccad09d5",
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"app\": {\n \"id\": \"5d8cff3cd55b040010928b5b\",\n \"displayName\": \"utoc\",\n \"settings\": {\n \"conversationRetentionSeconds\": 35855812,\n \"maskCreditCardNumbers\": true,\n \"useAnimalNames\": false,\n \"echoPostback\": true,\n \"ignoreAutoConversationStart\": true,\n \"multiConvoEnabled\": true,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n}"
},
{
"id": "8aa1f69d-ba23-420b-ae3f-870557fcf2ce",
"name": "App not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId"
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
