SQL Server / DocuSign REST API / Reserved: Sets the shared access information for users.
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.
-- {
-- "resultSetSize": "sample string 1",
-- "totalSetSize": "sample string 2",
-- "startPosition": "sample string 3",
-- "endPosition": "sample string 4",
-- "nextUri": "sample string 5",
-- "previousUri": "sample string 6",
-- "accountId": "sample string 7",
-- "sharedAccess": [
-- {
-- "user": {
-- "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"
-- },
-- "envelopes": [
-- {
-- "user": {},
-- "shared": "sample string 1"
-- }
-- ],
-- "templates": [
-- {
-- "templateId": "sample string 1",
-- "templateName": "sample string 2",
-- "owner": {},
-- "sharedUsers": [
-- {
-- "user": {}
-- }
-- ],
-- "sharedGroups": [
-- {
-- "group": {
-- "groupId": "sample string 1",
-- "groupName": "sample string 2",
-- "permissionProfileId": "sample string 3",
-- "groupType": "sample string 4",
-- "users": [
-- {}
-- ]
-- }
-- }
-- ],
-- "shared": "sample string 3"
-- }
-- ]
-- }
-- ]
-- }
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, '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'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'accountId', 'sample string 7'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.userName', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.userId', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.email', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.userType', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.userStatus', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.uri', 'sample string 6'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.loginStatus', 'sample string 7'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.sendActivationEmail', 'sample string 8'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].user.activationAccessCode', 'sample string 9'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'sharedAccess[0].envelopes[0].user'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].envelopes[0].shared', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].templateId', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].templateName', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'sharedAccess[0].templates[0].owner'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'sharedAccess[0].templates[0].sharedUsers[0].user'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].sharedGroups[0].group.groupId', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].sharedGroups[0].group.groupName', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].sharedGroups[0].group.permissionProfileId', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].sharedGroups[0].group.groupType', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sharedAccess[0].templates[0].shared', 'sample string 3'
-- 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}}/shared_access?item_type={{item_type}}&preserve_existing_shared_access={{preserve_existing_shared_access}}&user_ids={{user_ids}}', @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 '{
"resultSetSize": "sample string 1",
"totalSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"nextUri": "sample string 5",
"previousUri": "sample string 6",
"accountId": "sample string 7",
"sharedAccess": [
{
"user": {
"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"
},
"envelopes": [
{
"user": {},
"shared": "sample string 1"
}
],
"templates": [
{
"templateId": "sample string 1",
"templateName": "sample string 2",
"owner": {},
"sharedUsers": [
{
"user": {}
}
],
"sharedGroups": [
{
"group": {
"groupId": "sample string 1",
"groupName": "sample string 2",
"permissionProfileId": "sample string 3",
"groupType": "sample string 4",
"users": [
{}
]
}
}
],
"shared": "sample string 3"
}
]
}
]
}'
https://domain.com/v2.1/accounts/{{accountId}}/shared_access?item_type={{item_type}}&preserve_existing_shared_access={{preserve_existing_shared_access}}&user_ids={{user_ids}}
Postman Collection Item JSON
{
"name": "Reserved: Sets the shared access information for users.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"accountId\": \"sample string 7\",\n \"sharedAccess\": [\n {\n \"user\": {\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 \"envelopes\": [\n {\n \"user\": {},\n \"shared\": \"sample string 1\"\n }\n ],\n \"templates\": [\n {\n \"templateId\": \"sample string 1\",\n \"templateName\": \"sample string 2\",\n \"owner\": {},\n \"sharedUsers\": [\n {\n \"user\": {}\n }\n ],\n \"sharedGroups\": [\n {\n \"group\": {\n \"groupId\": \"sample string 1\",\n \"groupName\": \"sample string 2\",\n \"permissionProfileId\": \"sample string 3\",\n \"groupType\": \"sample string 4\",\n \"users\": [\n {}\n ]\n }\n }\n ],\n \"shared\": \"sample string 3\"\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/shared_access?item_type={{item_type}}&preserve_existing_shared_access={{preserve_existing_shared_access}}&user_ids={{user_ids}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"shared_access"
],
"query": [
{
"key": "item_type",
"value": "{{item_type}}"
},
{
"key": "preserve_existing_shared_access",
"value": "{{preserve_existing_shared_access}}"
},
{
"key": "user_ids",
"value": "{{user_ids}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Reserved: Sets the shared access information for one or more users."
},
"response": [
]
}
