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', '{{secretId}}'
EXEC sp_OASetProperty @http, 'Password', '{{secretPassword}}'
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/api/owners/:id/', @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)
-- {
-- "id": "<uuid>",
-- "link": "<uuid>",
-- "collected_at": "<dateTime>",
-- "display_name": "<string>",
-- "first_name": "<string>",
-- "last_name": "<string>",
-- "second_last_name": "<string>",
-- "address": "<string>",
-- "email": "<email>",
-- "phone_number": "<string>",
-- "accounts": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ],
-- "gig_data": {
-- "collected_at": "<dateTime>",
-- "status": "<string>",
-- "acceptance_rate": "<number>"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @value nvarchar(4000)
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @link nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @link OUT, 'link'
DECLARE @collected_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @collected_at OUT, 'collected_at'
DECLARE @display_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @display_name OUT, 'display_name'
DECLARE @first_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'first_name'
DECLARE @last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'last_name'
DECLARE @second_last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @second_last_name OUT, 'second_last_name'
DECLARE @address nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @address OUT, 'address'
DECLARE @email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'email'
DECLARE @phone_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @phone_number OUT, 'phone_number'
DECLARE @Collected_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Collected_at OUT, 'gig_data.collected_at'
DECLARE @Status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'gig_data.status'
DECLARE @Acceptance_rate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Acceptance_rate OUT, 'gig_data.acceptance_rate'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'accounts'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'accounts[i].value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/owners/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/owners/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `owner.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific owner."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"display_name\": \"<string>\",\n\t\"first_name\": \"<string>\",\n\t\"last_name\": \"<string>\",\n\t\"second_last_name\": \"<string>\",\n\t\"address\": \"<string>\",\n\t\"email\": \"<email>\",\n\t\"phone_number\": \"<string>\",\n\t\"accounts\": [\n\t\t{\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t{\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t],\n\t\"gig_data\": {\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"status\": \"<string>\",\n\t\t\"acceptance_rate\": \"<number>\"\n\t}\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/owners/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
