Chilkat Online Tools

unicodeC / DocuSign eSignature REST API / Reserved: Sets the shared access information for users.

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

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

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"resultSetSize",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"totalSetSize",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"startPosition",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"endPosition",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"nextUri",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"previousUri",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"accountId",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.userName",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.userId",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.email",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.userType",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.userStatus",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.uri",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.loginStatus",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.sendActivationEmail",L"sample string 8");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].user.activationAccessCode",L"sample string 9");
    CkJsonObjectW_UpdateNewObject(json,L"sharedAccess[0].envelopes[0].user");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].envelopes[0].shared",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].templateId",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].templateName",L"sample string 2");
    CkJsonObjectW_UpdateNewObject(json,L"sharedAccess[0].templates[0].owner");
    CkJsonObjectW_UpdateNewObject(json,L"sharedAccess[0].templates[0].sharedUsers[0].user");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].sharedGroups[0].group.groupId",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].sharedGroups[0].group.groupName",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].sharedGroups[0].group.permissionProfileId",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].sharedGroups[0].group.groupType",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"sharedAccess[0].templates[0].shared",L"sample string 3");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttpW_putAuthToken(http,L"{{accessToken}}");
    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"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,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);

    }

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}}",
          "type": "string"
        }
      ]
    },
    "description": "Reserved: Sets the shared access information for one or more users."
  },
  "response": [
  ]
}