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
DECLARE @iTmp0 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "groups": [
-- {
-- "groupId": "sample string 1",
-- "groupName": "sample string 2",
-- "permissionProfileId": "sample string 3",
-- "groupType": "sample string 4",
-- "users": [
-- {
-- "userName": "sample string 1",
-- "userId": "sample string 2",
-- "email": "sample string 3",
-- "userType": "sample string 4",
-- "userStatus": "sample string 5",
-- "uri": "sample string 6",
-- "loginStatus": "sample string 7",
-- "sendActivationEmail": "sample string 8",
-- "activationAccessCode": "sample string 9"
-- }
-- ]
-- }
-- ],
-- "resultSetSize": "sample string 1",
-- "totalSetSize": "sample string 2",
-- "startPosition": "sample string 3",
-- "endPosition": "sample string 4",
-- "nextUri": "sample string 5",
-- "previousUri": "sample string 6"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].groupId', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].groupName', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].permissionProfileId', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].groupType', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].userName', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].userId', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].email', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].userType', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].userStatus', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].uri', 'sample string 6'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].loginStatus', 'sample string 7'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].sendActivationEmail', 'sample string 8'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'groups[0].users[0].activationAccessCode', 'sample string 9'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resultSetSize', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'totalSetSize', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startPosition', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'endPosition', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'nextUri', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'previousUri', 'sample string 6'
-- Adds the "Authorization: Bearer {{accessToken}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/{{templatePart}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"groups": [
{
"groupId": "sample string 1",
"groupName": "sample string 2",
"permissionProfileId": "sample string 3",
"groupType": "sample string 4",
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9"
}
]
}
],
"resultSetSize": "sample string 1",
"totalSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"nextUri": "sample string 5",
"previousUri": "sample string 6"
}'
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/{{templatePart}}
Postman Collection Item JSON
{
"name": "Shares a template with a group",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"groups\": [\n {\n \"groupId\": \"sample string 1\",\n \"groupName\": \"sample string 2\",\n \"permissionProfileId\": \"sample string 3\",\n \"groupType\": \"sample string 4\",\n \"users\": [\n {\n \"userName\": \"sample string 1\",\n \"userId\": \"sample string 2\",\n \"email\": \"sample string 3\",\n \"userType\": \"sample string 4\",\n \"userStatus\": \"sample string 5\",\n \"uri\": \"sample string 6\",\n \"loginStatus\": \"sample string 7\",\n \"sendActivationEmail\": \"sample string 8\",\n \"activationAccessCode\": \"sample string 9\"\n }\n ]\n }\n ],\n \"resultSetSize\": \"sample string 1\",\n \"totalSetSize\": \"sample string 2\",\n \"startPosition\": \"sample string 3\",\n \"endPosition\": \"sample string 4\",\n \"nextUri\": \"sample string 5\",\n \"previousUri\": \"sample string 6\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/{{templatePart}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"templates",
"{{templateId}}",
"{{templatePart}}"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "templateId",
"value": "{{templateId}}",
"type": "string"
},
{
"key": "templatePart",
"value": "{{templatePart}}",
"type": "string"
}
]
},
"description": "Shares a template with the specified members group."
},
"response": [
]
}
