phpAx / DocuSign REST API / Reserved: Sets the shared access information for users.
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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"
// }
// ]
// }
// ]
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('resultSetSize','sample string 1');
$json->UpdateString('totalSetSize','sample string 2');
$json->UpdateString('startPosition','sample string 3');
$json->UpdateString('endPosition','sample string 4');
$json->UpdateString('nextUri','sample string 5');
$json->UpdateString('previousUri','sample string 6');
$json->UpdateString('accountId','sample string 7');
$json->UpdateString('sharedAccess[0].user.userName','sample string 1');
$json->UpdateString('sharedAccess[0].user.userId','sample string 2');
$json->UpdateString('sharedAccess[0].user.email','sample string 3');
$json->UpdateString('sharedAccess[0].user.userType','sample string 4');
$json->UpdateString('sharedAccess[0].user.userStatus','sample string 5');
$json->UpdateString('sharedAccess[0].user.uri','sample string 6');
$json->UpdateString('sharedAccess[0].user.loginStatus','sample string 7');
$json->UpdateString('sharedAccess[0].user.sendActivationEmail','sample string 8');
$json->UpdateString('sharedAccess[0].user.activationAccessCode','sample string 9');
$json->UpdateNewObject('sharedAccess[0].envelopes[0].user');
$json->UpdateString('sharedAccess[0].envelopes[0].shared','sample string 1');
$json->UpdateString('sharedAccess[0].templates[0].templateId','sample string 1');
$json->UpdateString('sharedAccess[0].templates[0].templateName','sample string 2');
$json->UpdateNewObject('sharedAccess[0].templates[0].owner');
$json->UpdateNewObject('sharedAccess[0].templates[0].sharedUsers[0].user');
$json->UpdateString('sharedAccess[0].templates[0].sharedGroups[0].group.groupId','sample string 1');
$json->UpdateString('sharedAccess[0].templates[0].sharedGroups[0].group.groupName','sample string 2');
$json->UpdateString('sharedAccess[0].templates[0].sharedGroups[0].group.permissionProfileId','sample string 3');
$json->UpdateString('sharedAccess[0].templates[0].sharedGroups[0].group.groupType','sample string 4');
$json->UpdateString('sharedAccess[0].templates[0].shared','sample string 3');
// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->AuthToken = '{{accessToken}}';
$http->SetRequestHeader('Accept','application/json');
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);
// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('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);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
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": [
]
}
