Survey API

API change history

List of APIs related to Survey

Export to excel

Export completed session and/or reponse information (raw data) to excel

Try it

Request

Request URL

https://luminus.azure-api.net/survey/excel

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

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

Request body

Export setting

Sample
Schema

{
  "id": "string",
  "exportType": "string",
  "groupID": "string",
  "includeUserGroup": true,
  "includeUserFaculty": true,
  "includeQuestionsAndResponses": true,
  "sortBy": "string",
  "layout": {},
  "startDate": "string",
  "endDate": "string"
}

{
  "description": "export settings\r\nthe default list of information to be exported to excel will be :\r\n\r\nuser login id, \r\n\r\nstudent number, \r\n\r\nstudent name, \r\n\r\ntotal score obtained, \r\n\r\nduration of the attempts(if any), \r\n\r\ntime when student start this attempt,\r\n\r\ntime when student submit the answers (if any)\r\n\r\nThis input defines additional information which to be exported into excel.",
  "required": [
    "exportType",
    "id",
    "layout"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "assessmetn id",
      "type": "string"
    },
    "exportType": {
      "description": "list of sessions to be exported\r\n\r\nA: All Attempts/ C: All Completed Attempt",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "if set, system will export sessions of students which only belongs to this group. it not set, system will export sessions for all students",
      "type": "string"
    },
    "includeUserGroup": {
      "description": "below field is true means user group information is added to the excel",
      "type": "boolean"
    },
    "includeUserFaculty": {
      "description": "below field is true means user faculty/department information is added to the excel",
      "type": "boolean"
    },
    "includeQuestionsAndResponses": {
      "description": "below field is true means question text, student answer in each question is added to the excel",
      "type": "boolean"
    },
    "sortBy": {
      "description": "the default sort order of the information, possible value :Name, UserID, Number, StartDate or EndDate",
      "type": "string"
    },
    "layout": {
      "description": "export layout applies when IncludeQuestionsAndResponses is true\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
      "allOf": [
        {
          "format": "int32",
          "description": "export layout\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
          "enum": [
            1,
            2,
            3,
            4
          ],
          "type": "integer"
        }
      ]
    },
    "startDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started after this date will be returned. \r\nFor in-video quiz, only responses made after this date will be returned.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started before this date will be returned.\r\nFor in-video quiz, only responses made before this date will be returned.",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "exportType": "string",
  "groupID": "string",
  "includeUserGroup": true,
  "includeUserFaculty": true,
  "includeQuestionsAndResponses": true,
  "sortBy": "string",
  "layout": {},
  "startDate": "string",
  "endDate": "string"
}

{
  "description": "export settings\r\nthe default list of information to be exported to excel will be :\r\n\r\nuser login id, \r\n\r\nstudent number, \r\n\r\nstudent name, \r\n\r\ntotal score obtained, \r\n\r\nduration of the attempts(if any), \r\n\r\ntime when student start this attempt,\r\n\r\ntime when student submit the answers (if any)\r\n\r\nThis input defines additional information which to be exported into excel.",
  "required": [
    "exportType",
    "id",
    "layout"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "assessmetn id",
      "type": "string"
    },
    "exportType": {
      "description": "list of sessions to be exported\r\n\r\nA: All Attempts/ C: All Completed Attempt",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "if set, system will export sessions of students which only belongs to this group. it not set, system will export sessions for all students",
      "type": "string"
    },
    "includeUserGroup": {
      "description": "below field is true means user group information is added to the excel",
      "type": "boolean"
    },
    "includeUserFaculty": {
      "description": "below field is true means user faculty/department information is added to the excel",
      "type": "boolean"
    },
    "includeQuestionsAndResponses": {
      "description": "below field is true means question text, student answer in each question is added to the excel",
      "type": "boolean"
    },
    "sortBy": {
      "description": "the default sort order of the information, possible value :Name, UserID, Number, StartDate or EndDate",
      "type": "string"
    },
    "layout": {
      "description": "export layout applies when IncludeQuestionsAndResponses is true\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
      "allOf": [
        {
          "format": "int32",
          "description": "export layout\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
          "enum": [
            1,
            2,
            3,
            4
          ],
          "type": "integer"
        }
      ]
    },
    "startDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started after this date will be returned. \r\nFor in-video quiz, only responses made after this date will be returned.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started before this date will be returned.\r\nFor in-video quiz, only responses made before this date will be returned.",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "exportType": "string",
  "groupID": "string",
  "includeUserGroup": true,
  "includeUserFaculty": true,
  "includeQuestionsAndResponses": true,
  "sortBy": "string",
  "layout": {},
  "startDate": "string",
  "endDate": "string"
}

{
  "description": "export settings\r\nthe default list of information to be exported to excel will be :\r\n\r\nuser login id, \r\n\r\nstudent number, \r\n\r\nstudent name, \r\n\r\ntotal score obtained, \r\n\r\nduration of the attempts(if any), \r\n\r\ntime when student start this attempt,\r\n\r\ntime when student submit the answers (if any)\r\n\r\nThis input defines additional information which to be exported into excel.",
  "required": [
    "exportType",
    "id",
    "layout"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "assessmetn id",
      "type": "string"
    },
    "exportType": {
      "description": "list of sessions to be exported\r\n\r\nA: All Attempts/ C: All Completed Attempt",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "if set, system will export sessions of students which only belongs to this group. it not set, system will export sessions for all students",
      "type": "string"
    },
    "includeUserGroup": {
      "description": "below field is true means user group information is added to the excel",
      "type": "boolean"
    },
    "includeUserFaculty": {
      "description": "below field is true means user faculty/department information is added to the excel",
      "type": "boolean"
    },
    "includeQuestionsAndResponses": {
      "description": "below field is true means question text, student answer in each question is added to the excel",
      "type": "boolean"
    },
    "sortBy": {
      "description": "the default sort order of the information, possible value :Name, UserID, Number, StartDate or EndDate",
      "type": "string"
    },
    "layout": {
      "description": "export layout applies when IncludeQuestionsAndResponses is true\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
      "allOf": [
        {
          "format": "int32",
          "description": "export layout\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
          "enum": [
            1,
            2,
            3,
            4
          ],
          "type": "integer"
        }
      ]
    },
    "startDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started after this date will be returned. \r\nFor in-video quiz, only responses made after this date will be returned.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started before this date will be returned.\r\nFor in-video quiz, only responses made before this date will be returned.",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "exportType": "string",
  "groupID": "string",
  "includeUserGroup": true,
  "includeUserFaculty": true,
  "includeQuestionsAndResponses": true,
  "sortBy": "string",
  "layout": {},
  "startDate": "string",
  "endDate": "string"
}

{
  "description": "export settings\r\nthe default list of information to be exported to excel will be :\r\n\r\nuser login id, \r\n\r\nstudent number, \r\n\r\nstudent name, \r\n\r\ntotal score obtained, \r\n\r\nduration of the attempts(if any), \r\n\r\ntime when student start this attempt,\r\n\r\ntime when student submit the answers (if any)\r\n\r\nThis input defines additional information which to be exported into excel.",
  "required": [
    "exportType",
    "id",
    "layout"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "assessmetn id",
      "type": "string"
    },
    "exportType": {
      "description": "list of sessions to be exported\r\n\r\nA: All Attempts/ C: All Completed Attempt",
      "type": "string"
    },
    "groupID": {
      "format": "uuid",
      "description": "if set, system will export sessions of students which only belongs to this group. it not set, system will export sessions for all students",
      "type": "string"
    },
    "includeUserGroup": {
      "description": "below field is true means user group information is added to the excel",
      "type": "boolean"
    },
    "includeUserFaculty": {
      "description": "below field is true means user faculty/department information is added to the excel",
      "type": "boolean"
    },
    "includeQuestionsAndResponses": {
      "description": "below field is true means question text, student answer in each question is added to the excel",
      "type": "boolean"
    },
    "sortBy": {
      "description": "the default sort order of the information, possible value :Name, UserID, Number, StartDate or EndDate",
      "type": "string"
    },
    "layout": {
      "description": "export layout applies when IncludeQuestionsAndResponses is true\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
      "allOf": [
        {
          "format": "int32",
          "description": "export layout\r\n\r\n1. export all records in one excel sheet, one user per row\r\n\r\n2. export all records into one excel worksheet, one question per row\r\n\r\n3. split all records into multiple excel worksheet, one user per worksheet\r\n\r\n3. split all records into multiple excel worksheet, one question per worksheet",
          "enum": [
            1,
            2,
            3,
            4
          ],
          "type": "integer"
        }
      ]
    },
    "startDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started after this date will be returned. \r\nFor in-video quiz, only responses made after this date will be returned.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The date filter of the session result, if set, only sessions started before this date will be returned.\r\nFor in-video quiz, only responses made before this date will be returned.",
      "type": "string"
    }
  }
}

Responses

204 No Content

Success

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

403 Forbidden

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

404 Not Found

Not Found

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

200 OK

The exported excel file

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://luminus.azure-api.net/survey/excel"
-H "Content-Type: application/json-patch+json"
-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}");

            var uri = "https://luminus.azure-api.net/survey/excel?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // 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/survey/excel");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/survey/excel?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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/survey/excel";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_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/survey/excel');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// 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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/survey/excel?%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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/survey/excel?%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/survey/excel')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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