Quiz API

API change history

List of APIs related to Quiz

Get section

Get section

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Section id

  • (optional)
    string

    Accepted populate entities:Question

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Section information

Representations

{
  "description": "returned data for section",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "section id",
      "type": "string"
    },
    "assessmentId": {
      "format": "uuid",
      "description": "id of the assessment this section belongs to",
      "type": "string"
    },
    "name": {
      "description": "section name",
      "type": "string"
    },
    "description": {
      "description": "section description",
      "type": "string"
    },
    "displayQuestionMark": {
      "description": "whether to display the marks for each question for this section.",
      "default": false,
      "type": "boolean"
    },
    "displayedRandomQuestions": {
      "format": "int32",
      "description": "used only when RandomizeQuestions is set to true. \r\nif the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.",
      "type": "integer"
    },
    "randomizeQuestions": {
      "description": "allow system to randomly choose questions and display.",
      "type": "boolean"
    },
    "randomizeOptions": {
      "description": "allow system to display options in the question with a ranomized order.",
      "type": "boolean"
    },
    "requireRational": {
      "description": "allow student to enter rantional for the answer.",
      "type": "boolean"
    }
  }
}
{
  "id": "string",
  "assessmentId": "string",
  "name": "string",
  "description": "string",
  "displayQuestionMark": false,
  "displayedRandomQuestions": 0,
  "randomizeQuestions": true,
  "randomizeOptions": true,
  "requireRational": true
}
{
  "description": "returned data for section",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "section id",
      "type": "string"
    },
    "assessmentId": {
      "format": "uuid",
      "description": "id of the assessment this section belongs to",
      "type": "string"
    },
    "name": {
      "description": "section name",
      "type": "string"
    },
    "description": {
      "description": "section description",
      "type": "string"
    },
    "displayQuestionMark": {
      "description": "whether to display the marks for each question for this section.",
      "default": false,
      "type": "boolean"
    },
    "displayedRandomQuestions": {
      "format": "int32",
      "description": "used only when RandomizeQuestions is set to true. \r\nif the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.",
      "type": "integer"
    },
    "randomizeQuestions": {
      "description": "allow system to randomly choose questions and display.",
      "type": "boolean"
    },
    "randomizeOptions": {
      "description": "allow system to display options in the question with a ranomized order.",
      "type": "boolean"
    },
    "requireRational": {
      "description": "allow student to enter rantional for the answer.",
      "type": "boolean"
    }
  }
}
{
  "id": "string",
  "assessmentId": "string",
  "name": "string",
  "description": "string",
  "displayQuestionMark": false,
  "displayedRandomQuestions": 0,
  "randomizeQuestions": true,
  "randomizeOptions": true,
  "requireRational": true
}
{
  "description": "returned data for section",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "section id",
      "type": "string"
    },
    "assessmentId": {
      "format": "uuid",
      "description": "id of the assessment this section belongs to",
      "type": "string"
    },
    "name": {
      "description": "section name",
      "type": "string"
    },
    "description": {
      "description": "section description",
      "type": "string"
    },
    "displayQuestionMark": {
      "description": "whether to display the marks for each question for this section.",
      "default": false,
      "type": "boolean"
    },
    "displayedRandomQuestions": {
      "format": "int32",
      "description": "used only when RandomizeQuestions is set to true. \r\nif the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.",
      "type": "integer"
    },
    "randomizeQuestions": {
      "description": "allow system to randomly choose questions and display.",
      "type": "boolean"
    },
    "randomizeOptions": {
      "description": "allow system to display options in the question with a ranomized order.",
      "type": "boolean"
    },
    "requireRational": {
      "description": "allow student to enter rantional for the answer.",
      "type": "boolean"
    }
  }
}

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/assessment/section/{id}?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["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/assessment/section/{id}?" + 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/assessment/section/{id}");

            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
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/assessment/section/{id}?" + $.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/assessment/section/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"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/assessment/section/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '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
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/assessment/section/{id}?%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
    'populate': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/assessment/section/{id}?%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/assessment/section/{id}')

query = URI.encode_www_form({
    # Request parameters
    '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