Classic ASP / DocuSign eSignature REST API / Reserved: Gets the shared item status for one or more users.
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' 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 CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = Server.CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("count","{{count}}")
success = queryParams.UpdateString("envelopes_not_shared_user_status","{{envelopes_not_shared_user_status}}")
success = queryParams.UpdateString("folder_ids","{{folder_ids}}")
success = queryParams.UpdateString("item_type","{{item_type}}")
success = queryParams.UpdateString("search_text","{{search_text}}")
success = queryParams.UpdateString("shared","{{shared}}")
success = queryParams.UpdateString("start_position","{{start_position}}")
success = queryParams.UpdateString("user_ids","{{user_ids}}")
' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/shared_access",queryParams)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -G -d "count=%7B%7Bcount%7D%7D"
-d "envelopes_not_shared_user_status=%7B%7Benvelopes_not_shared_user_status%7D%7D"
-d "folder_ids=%7B%7Bfolder_ids%7D%7D"
-d "item_type=%7B%7Bitem_type%7D%7D"
-d "search_text=%7B%7Bsearch_text%7D%7D"
-d "shared=%7B%7Bshared%7D%7D"
-d "start_position=%7B%7Bstart_position%7D%7D"
-d "user_ids=%7B%7Buser_ids%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/shared_access
Postman Collection Item JSON
{
"name": "Reserved: Gets the shared item status for one or more users.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/shared_access?count={{count}}&envelopes_not_shared_user_status={{envelopes_not_shared_user_status}}&folder_ids={{folder_ids}}&item_type={{item_type}}&search_text={{search_text}}&shared={{shared}}&start_position={{start_position}}&user_ids={{user_ids}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"shared_access"
],
"query": [
{
"key": "count",
"value": "{{count}}"
},
{
"key": "envelopes_not_shared_user_status",
"value": "{{envelopes_not_shared_user_status}}"
},
{
"key": "folder_ids",
"value": "{{folder_ids}}"
},
{
"key": "item_type",
"value": "{{item_type}}"
},
{
"key": "search_text",
"value": "{{search_text}}"
},
{
"key": "shared",
"value": "{{shared}}"
},
{
"key": "start_position",
"value": "{{start_position}}"
},
{
"key": "user_ids",
"value": "{{user_ids}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
}
]
},
"description": "Reserved: Retrieves shared item status for one or more users and types of items.\n\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from."
},
"response": [
]
}
