External Tools API
API change historyList of APIs related to External Tools (LTI)
Get providers by module
- Only users who have access to the module can get the list.
- ConsumerKey, ConsumerSecret, LaunchURL, CustParams and LaunchData are not viewable by students.
Request
Request URL
Request parameters
-
(optional)string
Format - uuid. Resource ID, this parameter is required.
-
(optional)string
Populate additional information. Accepted entities: creator, lastUpdatedUser
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
Request headers
Request body
Responses
200 OK
Returns list of [API_LTI.API.Provider]
Representations
{
"type": "array",
"items": {
"description": "The Provider output class",
"required": [
"consumerKey",
"consumerSecret",
"createdDate",
"creatorID",
"id",
"installable",
"lastUpdatedBy",
"lastUpdatedDate",
"launchURL",
"name",
"publish"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Provider ID",
"type": "string"
},
"name": {
"description": "Provider name",
"type": "string"
},
"description": {
"description": "Provider description",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID, if any",
"type": "string"
},
"consumerKey": {
"description": "Consumer key",
"type": "string"
},
"consumerSecret": {
"description": "Consumer secret",
"type": "string"
},
"launchURL": {
"description": "Launch URL",
"type": "string"
},
"custParams": {
"description": "Custom key/value parameters",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true
},
"value": {
"type": "string",
"readOnly": true
}
}
}
},
"launchData": {
"description": "Indicate whether lis_person_name_full and lis_person_contact_email_primary should be included in the launch data. \r\nBoth lis_person_name_given and lis_person_name_family will be included if lis_person_name_full is included.",
"type": "array",
"items": {
"type": "string"
}
},
"publish": {
"description": "True if the provider is published\r\nPublish is only applicable to module-level LTI apps.",
"type": "boolean"
},
"installable": {
"description": "True if the provider can be installed\r\nInstallable is only applicable to system-level LTI apps.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "Parent ID, if any. ParentID is only applicable to module-level LTI apps.\r\nThe parent provider must be a system-level LTI app that can be installed.",
"type": "string"
},
"documentTarget": {
"description": "Document target should be either 'frame', 'iframe' or 'window'.",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date the provider is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "The Guid of the user who created the provider",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the provider",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the provider",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the provider",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "The date the provider is last updated",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "The Guid of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the provider",
"type": "string"
}
}
}
}
[
{
"id": "string",
"name": "string",
"description": "string",
"resourceID": "string",
"consumerKey": "string",
"consumerSecret": "string",
"launchURL": "string",
"custParams": [
{
"key": "string",
"value": "string"
}
],
"launchData": [
"string"
],
"publish": true,
"installable": true,
"parentID": "string",
"documentTarget": "string",
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
{
"type": "array",
"items": {
"description": "The Provider output class",
"required": [
"consumerKey",
"consumerSecret",
"createdDate",
"creatorID",
"id",
"installable",
"lastUpdatedBy",
"lastUpdatedDate",
"launchURL",
"name",
"publish"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Provider ID",
"type": "string"
},
"name": {
"description": "Provider name",
"type": "string"
},
"description": {
"description": "Provider description",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID, if any",
"type": "string"
},
"consumerKey": {
"description": "Consumer key",
"type": "string"
},
"consumerSecret": {
"description": "Consumer secret",
"type": "string"
},
"launchURL": {
"description": "Launch URL",
"type": "string"
},
"custParams": {
"description": "Custom key/value parameters",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true
},
"value": {
"type": "string",
"readOnly": true
}
}
}
},
"launchData": {
"description": "Indicate whether lis_person_name_full and lis_person_contact_email_primary should be included in the launch data. \r\nBoth lis_person_name_given and lis_person_name_family will be included if lis_person_name_full is included.",
"type": "array",
"items": {
"type": "string"
}
},
"publish": {
"description": "True if the provider is published\r\nPublish is only applicable to module-level LTI apps.",
"type": "boolean"
},
"installable": {
"description": "True if the provider can be installed\r\nInstallable is only applicable to system-level LTI apps.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "Parent ID, if any. ParentID is only applicable to module-level LTI apps.\r\nThe parent provider must be a system-level LTI app that can be installed.",
"type": "string"
},
"documentTarget": {
"description": "Document target should be either 'frame', 'iframe' or 'window'.",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date the provider is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "The Guid of the user who created the provider",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the provider",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the provider",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the provider",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "The date the provider is last updated",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "The Guid of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the provider",
"type": "string"
}
}
}
}
[
{
"id": "string",
"name": "string",
"description": "string",
"resourceID": "string",
"consumerKey": "string",
"consumerSecret": "string",
"launchURL": "string",
"custParams": [
{
"key": "string",
"value": "string"
}
],
"launchData": [
"string"
],
"publish": true,
"installable": true,
"parentID": "string",
"documentTarget": "string",
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
{
"type": "array",
"items": {
"description": "The Provider output class",
"required": [
"consumerKey",
"consumerSecret",
"createdDate",
"creatorID",
"id",
"installable",
"lastUpdatedBy",
"lastUpdatedDate",
"launchURL",
"name",
"publish"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Provider ID",
"type": "string"
},
"name": {
"description": "Provider name",
"type": "string"
},
"description": {
"description": "Provider description",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID, if any",
"type": "string"
},
"consumerKey": {
"description": "Consumer key",
"type": "string"
},
"consumerSecret": {
"description": "Consumer secret",
"type": "string"
},
"launchURL": {
"description": "Launch URL",
"type": "string"
},
"custParams": {
"description": "Custom key/value parameters",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true
},
"value": {
"type": "string",
"readOnly": true
}
}
}
},
"launchData": {
"description": "Indicate whether lis_person_name_full and lis_person_contact_email_primary should be included in the launch data. \r\nBoth lis_person_name_given and lis_person_name_family will be included if lis_person_name_full is included.",
"type": "array",
"items": {
"type": "string"
}
},
"publish": {
"description": "True if the provider is published\r\nPublish is only applicable to module-level LTI apps.",
"type": "boolean"
},
"installable": {
"description": "True if the provider can be installed\r\nInstallable is only applicable to system-level LTI apps.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "Parent ID, if any. ParentID is only applicable to module-level LTI apps.\r\nThe parent provider must be a system-level LTI app that can be installed.",
"type": "string"
},
"documentTarget": {
"description": "Document target should be either 'frame', 'iframe' or 'window'.",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date the provider is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "The Guid of the user who created the provider",
"type": "string"
},
"creatorName": {
"description": "The name of the user who created the provider",
"type": "string"
},
"creatorUserID": {
"description": "The user ID of the user who created the provider",
"type": "string"
},
"creatorEmail": {
"description": "The email address of the user who created the provider",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "The date the provider is last updated",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "The Guid of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByName": {
"description": "The name of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByUserID": {
"description": "The user ID of the user who last updated the provider",
"type": "string"
},
"lastUpdatedByEmail": {
"description": "The email address of the user who last updated the provider",
"type": "string"
}
}
}
}
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"
}
404 Not Found
Not Found
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/lti/?resID={string}&populate={string}&sortby={string}&offset={integer}&limit={integer}&where={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["resID"] = "{string}";
queryString["populate"] = "{string}";
queryString["sortby"] = "{string}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["where"] = "{string}";
var uri = "https://luminus.azure-api.net/lti/?" + 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/lti/");
builder.setParameter("resID", "{string}");
builder.setParameter("populate", "{string}");
builder.setParameter("sortby", "{string}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("where", "{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
"resID": "{string}",
"populate": "{string}",
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/lti/?" + $.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/lti/";
NSArray* array = @[
// Request parameters
@"entities=true",
@"resID={string}",
@"populate={string}",
@"sortby={string}",
@"offset={integer}",
@"limit={integer}",
@"where={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/lti/');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'resID' => '{string}',
'populate' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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
'resID': '{string}',
'populate': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/lti/?%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
'resID': '{string}',
'populate': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/lti/?%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/lti/')
query = URI.encode_www_form({
# Request parameters
'resID' => '{string}',
'populate' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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