sonet_group.get

Scope: sonet_group Permissions: for all

Description

Returns array of social network groups, each of which contains a field array when callng CSocNetGroup::GetList(). In this case only groups available to user as per permissions are returned.

Request:

https://mydomain.bitrix24.com/rest/sonet_group.get.json?auth=bbc392f317df617d02c942a78ad43aab&ORDER[NAME]=ASC&FILTER[%25NAME]=%D0%9F%D1%80%D0%BE%D0%B4

Response:

{"result":[{"ID":"3","SITE_ID":"s1","NAME":"\u041f\u0440\u043e\u0434\u0430\u0436\u0438",
"DESCRIPTION":"\u041c\u0430\u0440\u043a\u0435\u0442\u0438\u043d\u0433\u043e\u0432\u0430\u044f \u0433\u0440\u0443\u043f\u043f\u0430 \u043f\u043e \u043f\u0440\u043e\u0434\u0430\u0436\u0430\u043c",
"DATE_CREATE":"2013-11-06T07:45:12+04:00","DATE_UPDATE":"2013-11-06T07:45:12+04:00","ACTIVE":"Y","VISIBLE":"Y","OPENED":"N","CLOSED":"N","SUBJECT_ID":"1","OWNER_ID":"1",
"KEYWORDS":"\u043f\u0440\u043e\u0434\u0430\u0436\u0430, \u0442\u043e\u0432\u0430\u0440, \u043c\u0430\u0440\u043a\u0435\u0442\u0438\u043d\u0433, \u0440\u044b\u043d\u043e\u043a",
"NUMBER_OF_MEMBERS":"1","DATE_ACTIVITY":"2013-11-06T07:45:12+04:00","SUBJECT_NAME":"\u0420\u0430\u0431\u043e\u0447\u0438\u0435 \u0433\u0440\u0443\u043f\u043f\u044b",
"IMAGE":"https:\/\/cdn.bitrix24.ru\/b211545\/socialnetwork\/ba9\/ba9533b38f60ade077b64f06a60d7082\/2.jpg","IS_EXTRANET":"Y"}],"total":1}

Parameters

Parameter	Description
ORDER	Corresponds to the `arOrder` parameter of the CSocNetGroup::GetList() method.
FILTER	Corresponds to the `arFilter` parameter of the CSocNetGroup::GetList() method.
IS_ADMIN	When Y is passed, it is verified if the current user is the network administrator. If yes, then when group selection is performed, rights permission check gets disabled.

Returns the same fields as CSocNetGroup::GetList(), except INITIATE_PERMS, SPAM_PERMS and IMAGE_ID (return the IMAGE field, with file field of the corresponding IMAGE_ID instead of the latter).

Example

 // Get a list of all available social network groups, whose name begins with a substring "company" sorted alphabetically by name
 
 BX24.callMethod('sonet_group.get', {
 'ORDER': {
 'NAME': 'ASC'
 },
 'FILTER': {
 '%NAME': 'company'
 }
 });