GET api.ashx/v2/groups/{containerid}.{json|xml}
GET a group's details.
Scopes
Groups › Read Groups groups.groups.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| ContainerId | Guid? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| Id | int? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| Key | string | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| ParentGroupId | int? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{containerid}.json',
data: {
'containerid': '49fec544-6df7-4a82-872b-f8be586d5e9e'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 6,
"Url": "url",
"TotalMembers": 25,
"HasGroups": true,
"GroupCount": 8,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [
{
"Key": "key",
"Value": "value"
},
{
"Key": "key",
"Value": "value"
}
],
"ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 4
},
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Group>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>6</ParentGroupId>
<Url>url</Url>
<TotalMembers>25</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>8</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes>
<key>value</key>
<key>value</key>
</ExtendedAttributes>
<ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
<Container>
<ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
<ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
</Response>GET api.ashx/v2/groups/root.{json|xml}
GET the root group's details.
Scopes
Groups › Read Groups groups.groups.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| ContainerId | Guid? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| Id | int? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| Key | string | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional | |||
| ParentGroupId | int? | Either Id (or ContainerId) or Key + ParentGroupId is required. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/root.json'
}).then(function(response) {
// use response
});Example Responses
JSON
{
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 6,
"Url": "url",
"TotalMembers": 25,
"HasGroups": true,
"GroupCount": 8,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [
{
"Key": "key",
"Value": "value"
},
{
"Key": "key",
"Value": "value"
}
],
"ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 4
},
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Group>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>6</ParentGroupId>
<Url>url</Url>
<TotalMembers>25</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>8</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes>
<key>value</key>
<key>value</key>
</ExtendedAttributes>
<ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
<Container>
<ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
<ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
</Response>