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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>'
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
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "id": "0FB...",
-- "lastFeedAccessDate": null,
-- "role": "StandardMember",
-- "url": "/services/data/v58.0/chatter/group-memberships/0FB...",
-- "user": {
-- "additionalLabel": null,
-- "communityNickname": "integration1.4407085834085586E12",
-- "companyName": "Salesforce",
-- "displayName": "Integration User",
-- "firstName": "Integration",
-- "id": "005...",
-- "isActive": true,
-- "isInThisCommunity": true,
-- "lastName": "User",
-- "motif": {
-- "color": "1B96FF",
-- "largeIconUrl": "/img/icon/profile64.png",
-- "mediumIconUrl": "/img/icon/profile32.png",
-- "smallIconUrl": "/img/icon/profile16.png",
-- "svgIconUrl": null
-- },
-- "mySubscription": null,
-- "name": "Integration User",
-- "outOfOffice": {
-- "message": ""
-- },
-- "photo": {
-- "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
-- "largePhotoUrl": "https://<my_domain>/profilephoto/005/F",
-- "mediumPhotoUrl": "https://<my_domain>/profilephoto/005/M",
-- "photoVersionId": null,
-- "smallPhotoUrl": "https://<my_domain>/profilephoto/005/T",
-- "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?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"
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @lastFeedAccessDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lastFeedAccessDate OUT, 'lastFeedAccessDate'
DECLARE @role nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @role OUT, 'role'
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'url'
DECLARE @AdditionalLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AdditionalLabel OUT, 'user.additionalLabel'
DECLARE @CommunityNickname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CommunityNickname OUT, 'user.communityNickname'
DECLARE @CompanyName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CompanyName OUT, 'user.companyName'
DECLARE @DisplayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DisplayName OUT, 'user.displayName'
DECLARE @FirstName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FirstName OUT, 'user.firstName'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'user.id'
DECLARE @IsActive int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsActive OUT, 'user.isActive'
DECLARE @IsInThisCommunity int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsInThisCommunity OUT, 'user.isInThisCommunity'
DECLARE @LastName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastName OUT, 'user.lastName'
DECLARE @Color nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Color OUT, 'user.motif.color'
DECLARE @LargeIconUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LargeIconUrl OUT, 'user.motif.largeIconUrl'
DECLARE @MediumIconUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MediumIconUrl OUT, 'user.motif.mediumIconUrl'
DECLARE @SmallIconUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SmallIconUrl OUT, 'user.motif.smallIconUrl'
DECLARE @SvgIconUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SvgIconUrl OUT, 'user.motif.svgIconUrl'
DECLARE @MySubscription nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MySubscription OUT, 'user.mySubscription'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'user.name'
DECLARE @Message nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Message OUT, 'user.outOfOffice.message'
DECLARE @FullEmailPhotoUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FullEmailPhotoUrl OUT, 'user.photo.fullEmailPhotoUrl'
DECLARE @LargePhotoUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LargePhotoUrl OUT, 'user.photo.largePhotoUrl'
DECLARE @MediumPhotoUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MediumPhotoUrl OUT, 'user.photo.mediumPhotoUrl'
DECLARE @PhotoVersionId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PhotoVersionId OUT, 'user.photo.photoVersionId'
DECLARE @SmallPhotoUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SmallPhotoUrl OUT, 'user.photo.smallPhotoUrl'
DECLARE @StandardEmailPhotoUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @StandardEmailPhotoUrl OUT, 'user.photo.standardEmailPhotoUrl'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'user.photo.url'
DECLARE @Reputation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Reputation OUT, 'user.reputation'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'user.title'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'user.type'
DECLARE @userUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @userUrl OUT, 'user.url'
DECLARE @UserType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @UserType OUT, 'user.userType'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>
Postman Collection Item JSON
{
"name": "Group Members",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=<USER1_ID>",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members"
],
"query": [
{
"key": "userId",
"value": "<USER1_ID>"
}
],
"variable": [
{
"key": "GROUP_ID",
"value": ""
}
]
},
"description": "Members of a specified group. Get the members and add a member to a group. To add a member, the context user must be the group owner or moderator.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembers.htm"
},
"response": [
{
"name": "Successful Group Members",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=005...",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members"
],
"query": [
{
"key": "userId",
"value": "005..."
}
],
"variable": [
{
"key": "GROUP_ID",
"value": "0F9..."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:31: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 \"id\": \"0FB...\",\n \"lastFeedAccessDate\": null,\n \"role\": \"StandardMember\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"integration1.4407085834085586E12\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Integration User\",\n \"firstName\": \"Integration\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"User\",\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\": \"Integration User\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?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}"
}
]
}
