Success Alerts
API change historyImportant, action-required notations about a student that describe information that may impact their likelihood to be successful.
Alerts
Returns all alerts that were created within a specified date range for specified users.
Try itRequest
Request URL
Request parameters
-
(optional)string
Number of items to get per page (default is 100, maximum is 1000). Use in conjunction with "page" for paging.
-
(optional)string
The page of the results to return (default is 1). Use in conjunction with "pageSize" for paging.
-
(optional)string
The comma delimited list of properties to include details in the response. ('categories', 'createdBy', 'comments', 'student')
-
(optional)string
The comma delimited list of people identifiers to return.
-
(optional)dateTime
Start date in ISO8601 format for filtering on date range of when the alert was last modified.
-
(optional)dateTime
Start date in ISO8601 format for filtering on date range of when the alert was last modified.
Request headers
-
stringOAuth 2.0 access token obtained from Campus Labs. Supported grant types: Client credentials.
Request body
Responses
200 OK
Request completed successfully. List of Alerts returned.
Representations
{
"page": number,
"pageSize": number,
"totalValues": number,
"self": {
"href": string
},
"links": {
"first": {
"href": string
},
"last": {
"href": string
},
"next": {
"href": string
},
"previous": {
"href": string
}
},
"values": [{
"audienceType": 'All' or 'FullNetwork',
"canStudentView": "boolean",
"categories": {
"href": string
},
"comments": {
"href": string
},
"createdBy": {
"href": string
},
"createdOn": dateTime,
"details": string,
"id": number,
"status": 'Open' or 'Lowered',
"student": {
"href": string
},
"self": {
"href": string
}
}]
}
400 Bad Request
Request could not complete due to invalid parameters or format.
401 Unauthorized
Authorization has failed or been denied for this request.
500 Internal Server Error
An internal error has occurred. Please contact support@campuslabs.com.
Code samples
@ECHO OFF
curl -v -X GET "https://api.campuslabs.com/notations/alerts/?pageSize={string}&page={string}&expand={string}&createdOnStart={dateTime}&createdOnEnd={dateTime}&identifiers={string}&modifiedOnStart={dateTime}&modifiedOnEnd={dateTime}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--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}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["pageSize"] = "{string}";
queryString["page"] = "{string}";
queryString["expand"] = "{string}";
queryString["createdOnStart"] = "{dateTime}";
queryString["createdOnEnd"] = "{dateTime}";
queryString["identifiers"] = "{string}";
queryString["modifiedOnStart"] = "{dateTime}";
queryString["modifiedOnEnd"] = "{dateTime}";
var uri = "https://api.campuslabs.com/notations/alerts/?" + 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://api.campuslabs.com/notations/alerts/");
builder.setParameter("pageSize", "{string}");
builder.setParameter("page", "{string}");
builder.setParameter("expand", "{string}");
builder.setParameter("createdOnStart", "{dateTime}");
builder.setParameter("createdOnEnd", "{dateTime}");
builder.setParameter("identifiers", "{string}");
builder.setParameter("modifiedOnStart", "{dateTime}");
builder.setParameter("modifiedOnEnd", "{dateTime}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// 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
"pageSize": "{string}",
"page": "{string}",
"expand": "{string}",
"createdOnStart": "{dateTime}",
"createdOnEnd": "{dateTime}",
"identifiers": "{string}",
"modifiedOnStart": "{dateTime}",
"modifiedOnEnd": "{dateTime}",
};
$.ajax({
url: "https://api.campuslabs.com/notations/alerts/?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
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://api.campuslabs.com/notations/alerts/";
NSArray* array = @[
// Request parameters
@"entities=true",
@"pageSize={string}",
@"page={string}",
@"expand={string}",
@"createdOnStart={dateTime}",
@"createdOnEnd={dateTime}",
@"identifiers={string}",
@"modifiedOnStart={dateTime}",
@"modifiedOnEnd={dateTime}",
];
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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// 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://api.campuslabs.com/notations/alerts/');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'pageSize' => '{string}',
'page' => '{string}',
'expand' => '{string}',
'createdOnStart' => '{dateTime}',
'createdOnEnd' => '{dateTime}',
'identifiers' => '{string}',
'modifiedOnStart' => '{dateTime}',
'modifiedOnEnd' => '{dateTime}',
);
$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}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'pageSize': '{string}',
'page': '{string}',
'expand': '{string}',
'createdOnStart': '{dateTime}',
'createdOnEnd': '{dateTime}',
'identifiers': '{string}',
'modifiedOnStart': '{dateTime}',
'modifiedOnEnd': '{dateTime}',
})
try:
conn = httplib.HTTPSConnection('api.campuslabs.com')
conn.request("GET", "/notations/alerts/?%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}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'pageSize': '{string}',
'page': '{string}',
'expand': '{string}',
'createdOnStart': '{dateTime}',
'createdOnEnd': '{dateTime}',
'identifiers': '{string}',
'modifiedOnStart': '{dateTime}',
'modifiedOnEnd': '{dateTime}',
})
try:
conn = http.client.HTTPSConnection('api.campuslabs.com')
conn.request("GET", "/notations/alerts/?%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://api.campuslabs.com/notations/alerts/')
query = URI.encode_www_form({
# Request parameters
'pageSize' => '{string}',
'page' => '{string}',
'expand' => '{string}',
'createdOnStart' => '{dateTime}',
'createdOnEnd' => '{dateTime}',
'identifiers' => '{string}',
'modifiedOnStart' => '{dateTime}',
'modifiedOnEnd' => '{dateTime}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# 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