Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *AdditionalLabel;
const wchar_t *CommunityNickname;
const wchar_t *CompanyName;
const wchar_t *DisplayName;
const wchar_t *FirstName;
const wchar_t *Id;
BOOL IsActive;
BOOL IsInThisCommunity;
const wchar_t *LastName;
const wchar_t *Color;
const wchar_t *LargeIconUrl;
const wchar_t *MediumIconUrl;
const wchar_t *SmallIconUrl;
const wchar_t *SvgIconUrl;
const wchar_t *MySubscription;
const wchar_t *Name;
const wchar_t *Message;
const wchar_t *FullEmailPhotoUrl;
const wchar_t *LargePhotoUrl;
const wchar_t *MediumPhotoUrl;
const wchar_t *PhotoVersionId;
const wchar_t *SmallPhotoUrl;
const wchar_t *StandardEmailPhotoUrl;
const wchar_t *v_Url;
const wchar_t *Reputation;
const wchar_t *Title;
const wchar_t *v_Type;
const wchar_t *entityUrl;
const wchar_t *UserType;
const wchar_t *sharingType;
const wchar_t *currentPageUrl;
const wchar_t *linkShare;
const wchar_t *nextPageUrl;
const wchar_t *previousPageUrl;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "currentPageUrl": "/services/data/v58.0/connect/files/069.../file-shares",
// "linkShare": null,
// "nextPageUrl": null,
// "previousPageUrl": null,
// "shares": [
// {
// "entity": {
// "additionalLabel": null,
// "communityNickname": "User1696423780773910041",
// "companyName": "Salesforce",
// "displayName": "Name",
// "firstName": "firstName",
// "id": "005...",
// "isActive": true,
// "isInThisCommunity": true,
// "lastName": "Name",
// "motif": {
// "color": "1B96FF",
// "largeIconUrl": "/img/icon/profile64.png",
// "mediumIconUrl": "/img/icon/profile32.png",
// "smallIconUrl": "/img/icon/profile16.png",
// "svgIconUrl": null
// },
// "mySubscription": null,
// "name": "Name",
// "outOfOffice": {
// "message": ""
// },
// "photo": {
// "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
// "photoVersionId": "729...",
// "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/T",
// "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// },
// "reputation": null,
// "title": null,
// "type": "User",
// "url": "/services/data/v58.0/chatter/users/005...",
// "userType": "Internal"
// },
// "sharingType": "I"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
currentPageUrl = CkJsonObjectW_stringOf(jResp,L"currentPageUrl");
linkShare = CkJsonObjectW_stringOf(jResp,L"linkShare");
nextPageUrl = CkJsonObjectW_stringOf(jResp,L"nextPageUrl");
previousPageUrl = CkJsonObjectW_stringOf(jResp,L"previousPageUrl");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"shares");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
AdditionalLabel = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.additionalLabel");
CommunityNickname = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.communityNickname");
CompanyName = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.companyName");
DisplayName = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.displayName");
FirstName = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.firstName");
Id = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.id");
IsActive = CkJsonObjectW_BoolOf(jResp,L"shares[i].entity.isActive");
IsInThisCommunity = CkJsonObjectW_BoolOf(jResp,L"shares[i].entity.isInThisCommunity");
LastName = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.lastName");
Color = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.motif.color");
LargeIconUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.motif.largeIconUrl");
MediumIconUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.motif.mediumIconUrl");
SmallIconUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.motif.smallIconUrl");
SvgIconUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.motif.svgIconUrl");
MySubscription = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.mySubscription");
Name = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.name");
Message = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.outOfOffice.message");
FullEmailPhotoUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.fullEmailPhotoUrl");
LargePhotoUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.largePhotoUrl");
MediumPhotoUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.mediumPhotoUrl");
PhotoVersionId = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.photoVersionId");
SmallPhotoUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.smallPhotoUrl");
StandardEmailPhotoUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.standardEmailPhotoUrl");
v_Url = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.photo.url");
Reputation = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.reputation");
Title = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.title");
v_Type = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.type");
entityUrl = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.url");
UserType = CkJsonObjectW_stringOf(jResp,L"shares[i].entity.userType");
sharingType = CkJsonObjectW_stringOf(jResp,L"shares[i].sharingType");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/connect/files/:FILE_ID/file-shares
Postman Collection Item JSON
{
"name": "File Shares",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": ""
}
]
},
"description": "Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm"
},
"response": [
{
"name": "Successful File Shares",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"files",
":FILE_ID",
"file-shares"
],
"variable": [
{
"key": "FILE_ID",
"value": "0692o00000woaRkAAI"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:37:07 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"currentPageUrl\": \"/services/data/v58.0/connect/files/069.../file-shares\",\n \"linkShare\": null,\n \"nextPageUrl\": null,\n \"previousPageUrl\": null,\n \"shares\": [\n {\n \"entity\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"firstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"sharingType\": \"I\"\n }\n ]\n}"
}
]
}
