User API
API change historyList of APIs related to Account Management, User and Group
Get immediate level descendant groups
To get the immediate level descendant groups under the parent class group.
Applicable only to class groups.
Returns only the next level of descendant groups under the given main/parent class group.
Try itRequest
Request URL
Request parameters
-
(optional)string
Format - uuid. Group ID
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID.
Can only populate photo and/or groupIDs if populate students.
Request headers
Request body
Responses
200 OK
Returns a list of [API.Grouping.Groups]
Representations
{
"type": "array",
"items": {
"description": "base group model, can have multiple variations with additional properties",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "group id",
"type": "string"
},
"groupName": {
"description": "group name",
"type": "string"
},
"groupType": {
"description": "Types of groups",
"allOf": [
{
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32
],
"type": "integer"
}
]
},
"groupTypeName": {
"description": "Display name of the group type",
"type": "string",
"readOnly": true
},
"creatorID": {
"format": "uuid",
"description": "Creator of the group",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Module ID",
"type": "string"
},
"parentGroupID": {
"format": "uuid",
"description": "Parent Group ID for the group. Applicable only for sub-groups in class groups.",
"type": "string"
},
"groupAccess": {
"description": "group access for viewing and managing the group",
"allOf": [
{
"format": "int32",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
}
}
}
}
[
{
"id": "string",
"groupName": "string",
"groupType": {},
"groupTypeName": "string",
"creatorID": "string",
"resourceID": "string",
"parentGroupID": "string",
"groupAccess": {}
}
]
{
"type": "array",
"items": {
"description": "base group model, can have multiple variations with additional properties",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "group id",
"type": "string"
},
"groupName": {
"description": "group name",
"type": "string"
},
"groupType": {
"description": "Types of groups",
"allOf": [
{
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32
],
"type": "integer"
}
]
},
"groupTypeName": {
"description": "Display name of the group type",
"type": "string",
"readOnly": true
},
"creatorID": {
"format": "uuid",
"description": "Creator of the group",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Module ID",
"type": "string"
},
"parentGroupID": {
"format": "uuid",
"description": "Parent Group ID for the group. Applicable only for sub-groups in class groups.",
"type": "string"
},
"groupAccess": {
"description": "group access for viewing and managing the group",
"allOf": [
{
"format": "int32",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
}
}
}
}
[
{
"id": "string",
"groupName": "string",
"groupType": {},
"groupTypeName": "string",
"creatorID": "string",
"resourceID": "string",
"parentGroupID": "string",
"groupAccess": {}
}
]
{
"type": "array",
"items": {
"description": "base group model, can have multiple variations with additional properties",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "group id",
"type": "string"
},
"groupName": {
"description": "group name",
"type": "string"
},
"groupType": {
"description": "Types of groups",
"allOf": [
{
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32
],
"type": "integer"
}
]
},
"groupTypeName": {
"description": "Display name of the group type",
"type": "string",
"readOnly": true
},
"creatorID": {
"format": "uuid",
"description": "Creator of the group",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Module ID",
"type": "string"
},
"parentGroupID": {
"format": "uuid",
"description": "Parent Group ID for the group. Applicable only for sub-groups in class groups.",
"type": "string"
},
"groupAccess": {
"description": "group access for viewing and managing the group",
"allOf": [
{
"format": "int32",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
]
}
}
}
}
400 Bad Request
Bad Request
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
403 Forbidden
Login user not authorized to perform this action
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
500 Internal Server Error
Server Error
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
Code samples
@ECHO OFF
curl -v -X GET "https://luminus.azure-api.net/user/Group/Descendant?GroupID={string}&sortby={string}&offset={integer}&limit={integer}&where={string}&populate={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["GroupID"] = "{string}";
queryString["sortby"] = "{string}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["where"] = "{string}";
queryString["populate"] = "{string}";
var uri = "https://luminus.azure-api.net/user/Group/Descendant?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/user/Group/Descendant");
builder.setParameter("GroupID", "{string}");
builder.setParameter("sortby", "{string}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("where", "{string}");
builder.setParameter("populate", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"GroupID": "{string}",
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
"populate": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/user/Group/Descendant?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://luminus.azure-api.net/user/Group/Descendant";
NSArray* array = @[
// Request parameters
@"entities=true",
@"GroupID={string}",
@"sortby={string}",
@"offset={integer}",
@"limit={integer}",
@"where={string}",
@"populate={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://luminus.azure-api.net/user/Group/Descendant');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'GroupID' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{string}',
'populate' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'GroupID': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/user/Group/Descendant?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'GroupID': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/user/Group/Descendant?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://luminus.azure-api.net/user/Group/Descendant')
query = URI.encode_www_form({
# Request parameters
'GroupID' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{string}',
'populate' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body