SE OER Backend API

Comment

addComment

Adds a comment to the question.

Adds a comment for a question to the system


/Comment

Usage and SDK Samples

curl -X POST "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Comment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {

    public static void main(String[] args) {
        
        CommentApi apiInstance = new CommentApi();
        CommentItem body = ; // CommentItem | Comment item to add
        try {
            apiInstance.addComment(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#addComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentApi;

public class CommentApiExample {

    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        CommentItem body = ; // CommentItem | Comment item to add
        try {
            apiInstance.addComment(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#addComment");
            e.printStackTrace();
        }
    }
}
CommentItem *body = ; // Comment item to add (optional)

CommentApi *apiInstance = [[CommentApi alloc] init];

// Adds a comment to the question.
[apiInstance addCommentWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.CommentApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addComment(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addCommentExample
    {
        public void main()
        {

            var apiInstance = new CommentApi();
            var body = new CommentItem(); // CommentItem | Comment item to add (optional) 

            try
            {
                // Adds a comment to the question.
                apiInstance.addComment(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentApi.addComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommentApi();
$body = ; // CommentItem | Comment item to add

try {
    $api_instance->addComment($body);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->addComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentApi;

my $api_instance = WWW::SwaggerClient::CommentApi->new();
my $body = WWW::SwaggerClient::Object::CommentItem->new(); # CommentItem | Comment item to add

eval { 
    $api_instance->addComment(body => $body);
};
if ($@) {
    warn "Exception when calling CommentApi->addComment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommentApi()
body =  # CommentItem | Comment item to add (optional)

try: 
    # Adds a comment to the question.
    api_instance.add_comment(body=body)
except ApiException as e:
    print("Exception when calling CommentApi->addComment: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - item created

Status: 400 - invalid input, object invalid, an existing item already exists


getComment

Searches comment

By passing in the appropriate options, you can get a list of comments based on a question from the system.


/Comment

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Comment?questionID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommentApi;

import java.io.File;
import java.util.*;

public class CommentApiExample {

    public static void main(String[] args) {
        
        CommentApi apiInstance = new CommentApi();
        String questionID = questionID_example; // String | pass a required question ID to get comments for the question.
        try {
            array[CommentItem] result = apiInstance.getComment(questionID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getComment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommentApi;

public class CommentApiExample {

    public static void main(String[] args) {
        CommentApi apiInstance = new CommentApi();
        String questionID = questionID_example; // String | pass a required question ID to get comments for the question.
        try {
            array[CommentItem] result = apiInstance.getComment(questionID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentApi#getComment");
            e.printStackTrace();
        }
    }
}
String *questionID = questionID_example; // pass a required question ID to get comments for the question.

CommentApi *apiInstance = [[CommentApi alloc] init];

// Searches comment
[apiInstance getCommentWith:questionID
              completionHandler: ^(array[CommentItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.CommentApi()
var questionID = questionID_example; // {{String}} pass a required question ID to get comments for the question.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComment(questionID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCommentExample
    {
        public void main()
        {

            var apiInstance = new CommentApi();
            var questionID = questionID_example;  // String | pass a required question ID to get comments for the question.

            try
            {
                // Searches comment
                array[CommentItem] result = apiInstance.getComment(questionID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommentApi.getComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommentApi();
$questionID = questionID_example; // String | pass a required question ID to get comments for the question.

try {
    $result = $api_instance->getComment($questionID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentApi->getComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommentApi;

my $api_instance = WWW::SwaggerClient::CommentApi->new();
my $questionID = questionID_example; # String | pass a required question ID to get comments for the question.

eval { 
    my $result = $api_instance->getComment(questionID => $questionID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentApi->getComment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommentApi()
questionID = questionID_example # String | pass a required question ID to get comments for the question.

try: 
    # Searches comment
    api_response = api_instance.get_comment(questionID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentApi->getComment: %s\n" % e)

Parameters

Query parameters
Name Description
questionID*
String
pass a required question ID to get comments for the question.
Required

Responses

Status: 200 - search results matching criteria


Question

addQuestion

Adds a question item

Adds a question item to the system


/Questions

Usage and SDK Samples

curl -X POST "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Questions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuestionApi;

import java.io.File;
import java.util.*;

public class QuestionApiExample {

    public static void main(String[] args) {
        
        QuestionApi apiInstance = new QuestionApi();
        QuestionItem body = ; // QuestionItem | Question item to add
        try {
            apiInstance.addQuestion(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#addQuestion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuestionApi;

public class QuestionApiExample {

    public static void main(String[] args) {
        QuestionApi apiInstance = new QuestionApi();
        QuestionItem body = ; // QuestionItem | Question item to add
        try {
            apiInstance.addQuestion(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#addQuestion");
            e.printStackTrace();
        }
    }
}
QuestionItem *body = ; // Question item to add (optional)

QuestionApi *apiInstance = [[QuestionApi alloc] init];

// Adds a question item
[apiInstance addQuestionWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuestionApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addQuestion(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addQuestionExample
    {
        public void main()
        {

            var apiInstance = new QuestionApi();
            var body = new QuestionItem(); // QuestionItem | Question item to add (optional) 

            try
            {
                // Adds a question item
                apiInstance.addQuestion(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuestionApi.addQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuestionApi();
$body = ; // QuestionItem | Question item to add

try {
    $api_instance->addQuestion($body);
} catch (Exception $e) {
    echo 'Exception when calling QuestionApi->addQuestion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuestionApi;

my $api_instance = WWW::SwaggerClient::QuestionApi->new();
my $body = WWW::SwaggerClient::Object::QuestionItem->new(); # QuestionItem | Question item to add

eval { 
    $api_instance->addQuestion(body => $body);
};
if ($@) {
    warn "Exception when calling QuestionApi->addQuestion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuestionApi()
body =  # QuestionItem | Question item to add (optional)

try: 
    # Adds a question item
    api_instance.add_question(body=body)
except ApiException as e:
    print("Exception when calling QuestionApi->addQuestion: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - item created

Status: 400 - invalid input, object invalid, an existing item already exists


deleteQuestion

Delete a question item

Delete a question item in the system


/QuestionMod/{qid}

Usage and SDK Samples

curl -X DELETE "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/QuestionMod/{qid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuestionApi;

import java.io.File;
import java.util.*;

public class QuestionApiExample {

    public static void main(String[] args) {
        
        QuestionApi apiInstance = new QuestionApi();
        String qid = qid_example; // String | pass a required question ID for deleting that specific question
        try {
            apiInstance.deleteQuestion(qid);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#deleteQuestion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuestionApi;

public class QuestionApiExample {

    public static void main(String[] args) {
        QuestionApi apiInstance = new QuestionApi();
        String qid = qid_example; // String | pass a required question ID for deleting that specific question
        try {
            apiInstance.deleteQuestion(qid);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#deleteQuestion");
            e.printStackTrace();
        }
    }
}
String *qid = qid_example; // pass a required question ID for deleting that specific question

QuestionApi *apiInstance = [[QuestionApi alloc] init];

// Delete a question item
[apiInstance deleteQuestionWith:qid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuestionApi()
var qid = qid_example; // {{String}} pass a required question ID for deleting that specific question

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteQuestion(qid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteQuestionExample
    {
        public void main()
        {

            var apiInstance = new QuestionApi();
            var qid = qid_example;  // String | pass a required question ID for deleting that specific question

            try
            {
                // Delete a question item
                apiInstance.deleteQuestion(qid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuestionApi.deleteQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuestionApi();
$qid = qid_example; // String | pass a required question ID for deleting that specific question

try {
    $api_instance->deleteQuestion($qid);
} catch (Exception $e) {
    echo 'Exception when calling QuestionApi->deleteQuestion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuestionApi;

my $api_instance = WWW::SwaggerClient::QuestionApi->new();
my $qid = qid_example; # String | pass a required question ID for deleting that specific question

eval { 
    $api_instance->deleteQuestion(qid => $qid);
};
if ($@) {
    warn "Exception when calling QuestionApi->deleteQuestion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuestionApi()
qid = qid_example # String | pass a required question ID for deleting that specific question

try: 
    # Delete a question item
    api_instance.delete_question(qid)
except ApiException as e:
    print("Exception when calling QuestionApi->deleteQuestion: %s\n" % e)

Parameters

Path parameters
Name Description
qid*
String
pass a required question ID for deleting that specific question
Required

Responses

Status: 204 - item deleted

Status: 404 - object not found


getQuestions

Gets all questions in the system

By passing in the appropriate options, you can search for all available questions in the system.


/Questions

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Questions?username=&self=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuestionApi;

import java.io.File;
import java.util.*;

public class QuestionApiExample {

    public static void main(String[] args) {
        
        QuestionApi apiInstance = new QuestionApi();
        String username = username_example; // String | pass an optional username for looking up questions made by the username
        Boolean self = true; // Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user.
        Integer offset = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[QuestionItem] result = apiInstance.getQuestions(username, self, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#getQuestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuestionApi;

public class QuestionApiExample {

    public static void main(String[] args) {
        QuestionApi apiInstance = new QuestionApi();
        String username = username_example; // String | pass an optional username for looking up questions made by the username
        Boolean self = true; // Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user.
        Integer offset = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[QuestionItem] result = apiInstance.getQuestions(username, self, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#getQuestions");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // pass an optional username for looking up questions made by the username (optional)
Boolean *self = true; // pass an optional boolean for looking up questions made by the user or everyone besides the user. (optional)
Integer *offset = 56; // number of records to skip for pagination (optional)
Integer *limit = 56; // maximum number of records to return (optional)

QuestionApi *apiInstance = [[QuestionApi alloc] init];

// Gets all questions in the system
[apiInstance getQuestionsWith:username
    self:self
    offset:offset
    limit:limit
              completionHandler: ^(array[QuestionItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuestionApi()
var opts = { 
  'username': username_example, // {{String}} pass an optional username for looking up questions made by the username
  'self': true, // {{Boolean}} pass an optional boolean for looking up questions made by the user or everyone besides the user.
  'offset': 56, // {{Integer}} number of records to skip for pagination
  'limit': 56 // {{Integer}} maximum number of records to return
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQuestions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQuestionsExample
    {
        public void main()
        {

            var apiInstance = new QuestionApi();
            var username = username_example;  // String | pass an optional username for looking up questions made by the username (optional) 
            var self = true;  // Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user. (optional) 
            var offset = 56;  // Integer | number of records to skip for pagination (optional) 
            var limit = 56;  // Integer | maximum number of records to return (optional) 

            try
            {
                // Gets all questions in the system
                array[QuestionItem] result = apiInstance.getQuestions(username, self, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuestionApi.getQuestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuestionApi();
$username = username_example; // String | pass an optional username for looking up questions made by the username
$self = true; // Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user.
$offset = 56; // Integer | number of records to skip for pagination
$limit = 56; // Integer | maximum number of records to return

try {
    $result = $api_instance->getQuestions($username, $self, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuestionApi->getQuestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuestionApi;

my $api_instance = WWW::SwaggerClient::QuestionApi->new();
my $username = username_example; # String | pass an optional username for looking up questions made by the username
my $self = true; # Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user.
my $offset = 56; # Integer | number of records to skip for pagination
my $limit = 56; # Integer | maximum number of records to return

eval { 
    my $result = $api_instance->getQuestions(username => $username, self => $self, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuestionApi->getQuestions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuestionApi()
username = username_example # String | pass an optional username for looking up questions made by the username (optional)
self = true # Boolean | pass an optional boolean for looking up questions made by the user or everyone besides the user. (optional)
offset = 56 # Integer | number of records to skip for pagination (optional)
limit = 56 # Integer | maximum number of records to return (optional)

try: 
    # Gets all questions in the system
    api_response = api_instance.get_questions(username=username, self=self, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuestionApi->getQuestions: %s\n" % e)

Parameters

Query parameters
Name Description
username
String
pass an optional username for looking up questions made by the username
self
Boolean (boolean)
pass an optional boolean for looking up questions made by the user or everyone besides the user.
offset
Integer (int32)
number of records to skip for pagination
limit
Integer (int32)
maximum number of records to return

Responses

Status: 200 - search results matching criteria


patchQuestion

Updates a question item

Update a question item in the system


/QuestionMod/{qid}

Usage and SDK Samples

curl -X PATCH "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/QuestionMod/{qid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuestionApi;

import java.io.File;
import java.util.*;

public class QuestionApiExample {

    public static void main(String[] args) {
        
        QuestionApi apiInstance = new QuestionApi();
        String qid = qid_example; // String | pass a required question ID for updating that specific question
        QuestionItem body = ; // QuestionItem | Question item to update
        try {
            apiInstance.patchQuestion(qid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#patchQuestion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuestionApi;

public class QuestionApiExample {

    public static void main(String[] args) {
        QuestionApi apiInstance = new QuestionApi();
        String qid = qid_example; // String | pass a required question ID for updating that specific question
        QuestionItem body = ; // QuestionItem | Question item to update
        try {
            apiInstance.patchQuestion(qid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuestionApi#patchQuestion");
            e.printStackTrace();
        }
    }
}
String *qid = qid_example; // pass a required question ID for updating that specific question
QuestionItem *body = ; // Question item to update (optional)

QuestionApi *apiInstance = [[QuestionApi alloc] init];

// Updates a question item
[apiInstance patchQuestionWith:qid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuestionApi()
var qid = qid_example; // {{String}} pass a required question ID for updating that specific question

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.patchQuestion(qid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchQuestionExample
    {
        public void main()
        {

            var apiInstance = new QuestionApi();
            var qid = qid_example;  // String | pass a required question ID for updating that specific question
            var body = new QuestionItem(); // QuestionItem | Question item to update (optional) 

            try
            {
                // Updates a question item
                apiInstance.patchQuestion(qid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuestionApi.patchQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuestionApi();
$qid = qid_example; // String | pass a required question ID for updating that specific question
$body = ; // QuestionItem | Question item to update

try {
    $api_instance->patchQuestion($qid, $body);
} catch (Exception $e) {
    echo 'Exception when calling QuestionApi->patchQuestion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuestionApi;

my $api_instance = WWW::SwaggerClient::QuestionApi->new();
my $qid = qid_example; # String | pass a required question ID for updating that specific question
my $body = WWW::SwaggerClient::Object::QuestionItem->new(); # QuestionItem | Question item to update

eval { 
    $api_instance->patchQuestion(qid => $qid, body => $body);
};
if ($@) {
    warn "Exception when calling QuestionApi->patchQuestion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuestionApi()
qid = qid_example # String | pass a required question ID for updating that specific question
body =  # QuestionItem | Question item to update (optional)

try: 
    # Updates a question item
    api_instance.patch_question(qid, body=body)
except ApiException as e:
    print("Exception when calling QuestionApi->patchQuestion: %s\n" % e)

Parameters

Path parameters
Name Description
qid*
String
pass a required question ID for updating that specific question
Required
Body parameters
Name Description
body

Responses

Status: 200 - item created, item updated

Status: 404 - object not found


Quiz

generateQuiz

Gets a newly generated quiz which is an array of question items.

By passing in the appropriate options, you can get a newly generated quiz from the system.


/GenerateQuiz

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/GenerateQuiz?numQuestion=&topic="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuizApi;

import java.io.File;
import java.util.*;

public class QuizApiExample {

    public static void main(String[] args) {
        
        QuizApi apiInstance = new QuizApi();
        Integer numQuestion = 56; // Integer | pass an optional integer for defining the number of questions to add to a quiz.
        String topic = topic_example; // String | pass an optional topic name for specifying the topic the quiz will be based on.
        try {
            array[QuestionItem] result = apiInstance.generateQuiz(numQuestion, topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#generateQuiz");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuizApi;

public class QuizApiExample {

    public static void main(String[] args) {
        QuizApi apiInstance = new QuizApi();
        Integer numQuestion = 56; // Integer | pass an optional integer for defining the number of questions to add to a quiz.
        String topic = topic_example; // String | pass an optional topic name for specifying the topic the quiz will be based on.
        try {
            array[QuestionItem] result = apiInstance.generateQuiz(numQuestion, topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#generateQuiz");
            e.printStackTrace();
        }
    }
}
Integer *numQuestion = 56; // pass an optional integer for defining the number of questions to add to a quiz. (optional)
String *topic = topic_example; // pass an optional topic name for specifying the topic the quiz will be based on. (optional)

QuizApi *apiInstance = [[QuizApi alloc] init];

// Gets a newly generated quiz which is an array of question items.
[apiInstance generateQuizWith:numQuestion
    topic:topic
              completionHandler: ^(array[QuestionItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuizApi()
var opts = { 
  'numQuestion': 56, // {{Integer}} pass an optional integer for defining the number of questions to add to a quiz.
  'topic': topic_example // {{String}} pass an optional topic name for specifying the topic the quiz will be based on.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateQuiz(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class generateQuizExample
    {
        public void main()
        {

            var apiInstance = new QuizApi();
            var numQuestion = 56;  // Integer | pass an optional integer for defining the number of questions to add to a quiz. (optional) 
            var topic = topic_example;  // String | pass an optional topic name for specifying the topic the quiz will be based on. (optional) 

            try
            {
                // Gets a newly generated quiz which is an array of question items.
                array[QuestionItem] result = apiInstance.generateQuiz(numQuestion, topic);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuizApi.generateQuiz: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuizApi();
$numQuestion = 56; // Integer | pass an optional integer for defining the number of questions to add to a quiz.
$topic = topic_example; // String | pass an optional topic name for specifying the topic the quiz will be based on.

try {
    $result = $api_instance->generateQuiz($numQuestion, $topic);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuizApi->generateQuiz: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuizApi;

my $api_instance = WWW::SwaggerClient::QuizApi->new();
my $numQuestion = 56; # Integer | pass an optional integer for defining the number of questions to add to a quiz.
my $topic = topic_example; # String | pass an optional topic name for specifying the topic the quiz will be based on.

eval { 
    my $result = $api_instance->generateQuiz(numQuestion => $numQuestion, topic => $topic);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuizApi->generateQuiz: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuizApi()
numQuestion = 56 # Integer | pass an optional integer for defining the number of questions to add to a quiz. (optional)
topic = topic_example # String | pass an optional topic name for specifying the topic the quiz will be based on. (optional)

try: 
    # Gets a newly generated quiz which is an array of question items.
    api_response = api_instance.generate_quiz(numQuestion=numQuestion, topic=topic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuizApi->generateQuiz: %s\n" % e)

Parameters

Query parameters
Name Description
numQuestion
Integer
pass an optional integer for defining the number of questions to add to a quiz.
topic
String
pass an optional topic name for specifying the topic the quiz will be based on.

Responses

Status: 200 - search results matching criteria


getQuiz

Gets a newly generated quiz which is an array of question items.

You can get all quizzes from the system.


/Quiz

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Quiz"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuizApi;

import java.io.File;
import java.util.*;

public class QuizApiExample {

    public static void main(String[] args) {
        
        QuizApi apiInstance = new QuizApi();
        try {
            array[QuizItem] result = apiInstance.getQuiz();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#getQuiz");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuizApi;

public class QuizApiExample {

    public static void main(String[] args) {
        QuizApi apiInstance = new QuizApi();
        try {
            array[QuizItem] result = apiInstance.getQuiz();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#getQuiz");
            e.printStackTrace();
        }
    }
}

QuizApi *apiInstance = [[QuizApi alloc] init];

// Gets a newly generated quiz which is an array of question items.
[apiInstance getQuizWithCompletionHandler: 
              ^(array[QuizItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuizApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQuiz(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQuizExample
    {
        public void main()
        {

            var apiInstance = new QuizApi();

            try
            {
                // Gets a newly generated quiz which is an array of question items.
                array[QuizItem] result = apiInstance.getQuiz();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuizApi.getQuiz: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuizApi();

try {
    $result = $api_instance->getQuiz();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuizApi->getQuiz: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuizApi;

my $api_instance = WWW::SwaggerClient::QuizApi->new();

eval { 
    my $result = $api_instance->getQuiz();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuizApi->getQuiz: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuizApi()

try: 
    # Gets a newly generated quiz which is an array of question items.
    api_response = api_instance.get_quiz()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuizApi->getQuiz: %s\n" % e)

Parameters

Responses

Status: 200 - search results matching criteria


submitQuiz

Adds a completed quiz item

Adds a completed quiz item to the system


/Quiz

Usage and SDK Samples

curl -X POST "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Quiz"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuizApi;

import java.io.File;
import java.util.*;

public class QuizApiExample {

    public static void main(String[] args) {
        
        QuizApi apiInstance = new QuizApi();
        QuizItem body = ; // QuizItem | Question item to add
        try {
            apiInstance.submitQuiz(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#submitQuiz");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuizApi;

public class QuizApiExample {

    public static void main(String[] args) {
        QuizApi apiInstance = new QuizApi();
        QuizItem body = ; // QuizItem | Question item to add
        try {
            apiInstance.submitQuiz(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuizApi#submitQuiz");
            e.printStackTrace();
        }
    }
}
QuizItem *body = ; // Question item to add (optional)

QuizApi *apiInstance = [[QuizApi alloc] init];

// Adds a completed quiz item
[apiInstance submitQuizWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.QuizApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.submitQuiz(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class submitQuizExample
    {
        public void main()
        {

            var apiInstance = new QuizApi();
            var body = new QuizItem(); // QuizItem | Question item to add (optional) 

            try
            {
                // Adds a completed quiz item
                apiInstance.submitQuiz(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuizApi.submitQuiz: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiQuizApi();
$body = ; // QuizItem | Question item to add

try {
    $api_instance->submitQuiz($body);
} catch (Exception $e) {
    echo 'Exception when calling QuizApi->submitQuiz: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuizApi;

my $api_instance = WWW::SwaggerClient::QuizApi->new();
my $body = WWW::SwaggerClient::Object::QuizItem->new(); # QuizItem | Question item to add

eval { 
    $api_instance->submitQuiz(body => $body);
};
if ($@) {
    warn "Exception when calling QuizApi->submitQuiz: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuizApi()
body =  # QuizItem | Question item to add (optional)

try: 
    # Adds a completed quiz item
    api_instance.submit_quiz(body=body)
except ApiException as e:
    print("Exception when calling QuizApi->submitQuiz: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - item created

Status: 400 - invalid input, object invalid, an existing item already exists


Rating

addRating

Adds a rating for a question.

Adds a rating for a question to the system


/MyQuestionRatings

Usage and SDK Samples

curl -X POST "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/MyQuestionRatings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RatingApi;

import java.io.File;
import java.util.*;

public class RatingApiExample {

    public static void main(String[] args) {
        
        RatingApi apiInstance = new RatingApi();
        RatingItem body = ; // RatingItem | Rating item to add
        try {
            apiInstance.addRating(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingApi#addRating");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RatingApi;

public class RatingApiExample {

    public static void main(String[] args) {
        RatingApi apiInstance = new RatingApi();
        RatingItem body = ; // RatingItem | Rating item to add
        try {
            apiInstance.addRating(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingApi#addRating");
            e.printStackTrace();
        }
    }
}
RatingItem *body = ; // Rating item to add (optional)

RatingApi *apiInstance = [[RatingApi alloc] init];

// Adds a rating for a question.
[apiInstance addRatingWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.RatingApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addRating(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addRatingExample
    {
        public void main()
        {

            var apiInstance = new RatingApi();
            var body = new RatingItem(); // RatingItem | Rating item to add (optional) 

            try
            {
                // Adds a rating for a question.
                apiInstance.addRating(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingApi.addRating: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRatingApi();
$body = ; // RatingItem | Rating item to add

try {
    $api_instance->addRating($body);
} catch (Exception $e) {
    echo 'Exception when calling RatingApi->addRating: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RatingApi;

my $api_instance = WWW::SwaggerClient::RatingApi->new();
my $body = WWW::SwaggerClient::Object::RatingItem->new(); # RatingItem | Rating item to add

eval { 
    $api_instance->addRating(body => $body);
};
if ($@) {
    warn "Exception when calling RatingApi->addRating: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RatingApi()
body =  # RatingItem | Rating item to add (optional)

try: 
    # Adds a rating for a question.
    api_instance.add_rating(body=body)
except ApiException as e:
    print("Exception when calling RatingApi->addRating: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - item created

Status: 400 - invalid input, object invalid, an existing item already exists


getQuestionRating

Get question ratings

By passing in the appropriate options, you can get ratings on questions in the system.


/MyQuestionRatings

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/MyQuestionRatings?username="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RatingApi;

import java.io.File;
import java.util.*;

public class RatingApiExample {

    public static void main(String[] args) {
        
        RatingApi apiInstance = new RatingApi();
        String username = username_example; // String | pass an optional username to get ratings made by the user.
        try {
            array[RatingItem] result = apiInstance.getQuestionRating(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingApi#getQuestionRating");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RatingApi;

public class RatingApiExample {

    public static void main(String[] args) {
        RatingApi apiInstance = new RatingApi();
        String username = username_example; // String | pass an optional username to get ratings made by the user.
        try {
            array[RatingItem] result = apiInstance.getQuestionRating(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RatingApi#getQuestionRating");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // pass an optional username to get ratings made by the user. (optional)

RatingApi *apiInstance = [[RatingApi alloc] init];

// Get question ratings
[apiInstance getQuestionRatingWith:username
              completionHandler: ^(array[RatingItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.RatingApi()
var opts = { 
  'username': username_example // {{String}} pass an optional username to get ratings made by the user.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQuestionRating(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQuestionRatingExample
    {
        public void main()
        {

            var apiInstance = new RatingApi();
            var username = username_example;  // String | pass an optional username to get ratings made by the user. (optional) 

            try
            {
                // Get question ratings
                array[RatingItem] result = apiInstance.getQuestionRating(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingApi.getQuestionRating: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRatingApi();
$username = username_example; // String | pass an optional username to get ratings made by the user.

try {
    $result = $api_instance->getQuestionRating($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RatingApi->getQuestionRating: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RatingApi;

my $api_instance = WWW::SwaggerClient::RatingApi->new();
my $username = username_example; # String | pass an optional username to get ratings made by the user.

eval { 
    my $result = $api_instance->getQuestionRating(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RatingApi->getQuestionRating: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RatingApi()
username = username_example # String | pass an optional username to get ratings made by the user. (optional)

try: 
    # Get question ratings
    api_response = api_instance.get_question_rating(username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RatingApi->getQuestionRating: %s\n" % e)

Parameters

Query parameters
Name Description
username
String
pass an optional username to get ratings made by the user.

Responses

Status: 200 - search results matching criteria


Statistics

getStatsByQuestion

Get question-based statistics

By passing in the appropriate options, you can get statistics based on questions in the system.


/NumberofQuestions

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/NumberofQuestions?topic=&learningOutcome="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatisticsApi;

import java.io.File;
import java.util.*;

public class StatisticsApiExample {

    public static void main(String[] args) {
        
        StatisticsApi apiInstance = new StatisticsApi();
        String topic = topic_example; // String | pass an optional topic to get statistics based on the topic.
        String learningOutcome = learningOutcome_example; // String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic.
        try {
            array[QuestionStatisticItem] result = apiInstance.getStatsByQuestion(topic, learningOutcome);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#getStatsByQuestion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatisticsApi;

public class StatisticsApiExample {

    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        String topic = topic_example; // String | pass an optional topic to get statistics based on the topic.
        String learningOutcome = learningOutcome_example; // String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic.
        try {
            array[QuestionStatisticItem] result = apiInstance.getStatsByQuestion(topic, learningOutcome);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#getStatsByQuestion");
            e.printStackTrace();
        }
    }
}
String *topic = topic_example; // pass an optional topic to get statistics based on the topic. (optional)
String *learningOutcome = learningOutcome_example; // pass an optional learning outcome name to get statistics based on a learning outcome of a topic. (optional)

StatisticsApi *apiInstance = [[StatisticsApi alloc] init];

// Get question-based statistics
[apiInstance getStatsByQuestionWith:topic
    learningOutcome:learningOutcome
              completionHandler: ^(array[QuestionStatisticItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.StatisticsApi()
var opts = { 
  'topic': topic_example, // {{String}} pass an optional topic to get statistics based on the topic.
  'learningOutcome': learningOutcome_example // {{String}} pass an optional learning outcome name to get statistics based on a learning outcome of a topic.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatsByQuestion(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatsByQuestionExample
    {
        public void main()
        {

            var apiInstance = new StatisticsApi();
            var topic = topic_example;  // String | pass an optional topic to get statistics based on the topic. (optional) 
            var learningOutcome = learningOutcome_example;  // String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic. (optional) 

            try
            {
                // Get question-based statistics
                array[QuestionStatisticItem] result = apiInstance.getStatsByQuestion(topic, learningOutcome);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatisticsApi.getStatsByQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatisticsApi();
$topic = topic_example; // String | pass an optional topic to get statistics based on the topic.
$learningOutcome = learningOutcome_example; // String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic.

try {
    $result = $api_instance->getStatsByQuestion($topic, $learningOutcome);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatisticsApi->getStatsByQuestion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatisticsApi;

my $api_instance = WWW::SwaggerClient::StatisticsApi->new();
my $topic = topic_example; # String | pass an optional topic to get statistics based on the topic.
my $learningOutcome = learningOutcome_example; # String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic.

eval { 
    my $result = $api_instance->getStatsByQuestion(topic => $topic, learningOutcome => $learningOutcome);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatisticsApi->getStatsByQuestion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatisticsApi()
topic = topic_example # String | pass an optional topic to get statistics based on the topic. (optional)
learningOutcome = learningOutcome_example # String | pass an optional learning outcome name to get statistics based on a learning outcome of a topic. (optional)

try: 
    # Get question-based statistics
    api_response = api_instance.get_stats_by_question(topic=topic, learningOutcome=learningOutcome)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->getStatsByQuestion: %s\n" % e)

Parameters

Query parameters
Name Description
topic
String
pass an optional topic to get statistics based on the topic.
learningOutcome
String
pass an optional learning outcome name to get statistics based on a learning outcome of a topic.

Responses

Status: 200 - search results matching criteria


getStatsByTopic

Get topic-based statistics

By passing in the appropriate options, you can get statistics based on a topic(s) from the system.


/StatsByTopic

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/StatsByTopic?username=&topic="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatisticsApi;

import java.io.File;
import java.util.*;

public class StatisticsApiExample {

    public static void main(String[] args) {
        
        StatisticsApi apiInstance = new StatisticsApi();
        String username = username_example; // String | pass an optional username to get statistics based on the user.
        String topic = topic_example; // String | pass an optional topic name to get statistics based on a topic.
        try {
            array[QuizStatisticItem] result = apiInstance.getStatsByTopic(username, topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#getStatsByTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatisticsApi;

public class StatisticsApiExample {

    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        String username = username_example; // String | pass an optional username to get statistics based on the user.
        String topic = topic_example; // String | pass an optional topic name to get statistics based on a topic.
        try {
            array[QuizStatisticItem] result = apiInstance.getStatsByTopic(username, topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#getStatsByTopic");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // pass an optional username to get statistics based on the user. (optional)
String *topic = topic_example; // pass an optional topic name to get statistics based on a topic. (optional)

StatisticsApi *apiInstance = [[StatisticsApi alloc] init];

// Get topic-based statistics
[apiInstance getStatsByTopicWith:username
    topic:topic
              completionHandler: ^(array[QuizStatisticItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.StatisticsApi()
var opts = { 
  'username': username_example, // {{String}} pass an optional username to get statistics based on the user.
  'topic': topic_example // {{String}} pass an optional topic name to get statistics based on a topic.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatsByTopic(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStatsByTopicExample
    {
        public void main()
        {

            var apiInstance = new StatisticsApi();
            var username = username_example;  // String | pass an optional username to get statistics based on the user. (optional) 
            var topic = topic_example;  // String | pass an optional topic name to get statistics based on a topic. (optional) 

            try
            {
                // Get topic-based statistics
                array[QuizStatisticItem] result = apiInstance.getStatsByTopic(username, topic);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatisticsApi.getStatsByTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatisticsApi();
$username = username_example; // String | pass an optional username to get statistics based on the user.
$topic = topic_example; // String | pass an optional topic name to get statistics based on a topic.

try {
    $result = $api_instance->getStatsByTopic($username, $topic);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatisticsApi->getStatsByTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatisticsApi;

my $api_instance = WWW::SwaggerClient::StatisticsApi->new();
my $username = username_example; # String | pass an optional username to get statistics based on the user.
my $topic = topic_example; # String | pass an optional topic name to get statistics based on a topic.

eval { 
    my $result = $api_instance->getStatsByTopic(username => $username, topic => $topic);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatisticsApi->getStatsByTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatisticsApi()
username = username_example # String | pass an optional username to get statistics based on the user. (optional)
topic = topic_example # String | pass an optional topic name to get statistics based on a topic. (optional)

try: 
    # Get topic-based statistics
    api_response = api_instance.get_stats_by_topic(username=username, topic=topic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->getStatsByTopic: %s\n" % e)

Parameters

Query parameters
Name Description
username
String
pass an optional username to get statistics based on the user.
topic
String
pass an optional topic name to get statistics based on a topic.

Responses

Status: 200 - search results matching criteria


Topic

addTopic

Adds a topic item

Adds a topic item to the system


/Topics

Usage and SDK Samples

curl -X POST "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicApi;

import java.io.File;
import java.util.*;

public class TopicApiExample {

    public static void main(String[] args) {
        
        TopicApi apiInstance = new TopicApi();
        TopicItem body = ; // TopicItem | Topic item to add
        try {
            apiInstance.addTopic(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#addTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicApi;

public class TopicApiExample {

    public static void main(String[] args) {
        TopicApi apiInstance = new TopicApi();
        TopicItem body = ; // TopicItem | Topic item to add
        try {
            apiInstance.addTopic(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#addTopic");
            e.printStackTrace();
        }
    }
}
TopicItem *body = ; // Topic item to add (optional)

TopicApi *apiInstance = [[TopicApi alloc] init];

// Adds a topic item
[apiInstance addTopicWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.TopicApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addTopic(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addTopicExample
    {
        public void main()
        {

            var apiInstance = new TopicApi();
            var body = new TopicItem(); // TopicItem | Topic item to add (optional) 

            try
            {
                // Adds a topic item
                apiInstance.addTopic(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicApi.addTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicApi();
$body = ; // TopicItem | Topic item to add

try {
    $api_instance->addTopic($body);
} catch (Exception $e) {
    echo 'Exception when calling TopicApi->addTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicApi;

my $api_instance = WWW::SwaggerClient::TopicApi->new();
my $body = WWW::SwaggerClient::Object::TopicItem->new(); # TopicItem | Topic item to add

eval { 
    $api_instance->addTopic(body => $body);
};
if ($@) {
    warn "Exception when calling TopicApi->addTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicApi()
body =  # TopicItem | Topic item to add (optional)

try: 
    # Adds a topic item
    api_instance.add_topic(body=body)
except ApiException as e:
    print("Exception when calling TopicApi->addTopic: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - item created

Status: 400 - invalid input, object invalid, an existing item already exists


deleteTopic

Delete a topic item

Delete a topic item in the system


/TopicMod/{name}

Usage and SDK Samples

curl -X DELETE "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/TopicMod/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicApi;

import java.io.File;
import java.util.*;

public class TopicApiExample {

    public static void main(String[] args) {
        
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass a required topic name for deleting that specific topic
        try {
            apiInstance.deleteTopic(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#deleteTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicApi;

public class TopicApiExample {

    public static void main(String[] args) {
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass a required topic name for deleting that specific topic
        try {
            apiInstance.deleteTopic(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#deleteTopic");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // pass a required topic name for deleting that specific topic

TopicApi *apiInstance = [[TopicApi alloc] init];

// Delete a topic item
[apiInstance deleteTopicWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.TopicApi()
var name = name_example; // {{String}} pass a required topic name for deleting that specific topic

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTopic(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTopicExample
    {
        public void main()
        {

            var apiInstance = new TopicApi();
            var name = name_example;  // String | pass a required topic name for deleting that specific topic

            try
            {
                // Delete a topic item
                apiInstance.deleteTopic(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicApi.deleteTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicApi();
$name = name_example; // String | pass a required topic name for deleting that specific topic

try {
    $api_instance->deleteTopic($name);
} catch (Exception $e) {
    echo 'Exception when calling TopicApi->deleteTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicApi;

my $api_instance = WWW::SwaggerClient::TopicApi->new();
my $name = name_example; # String | pass a required topic name for deleting that specific topic

eval { 
    $api_instance->deleteTopic(name => $name);
};
if ($@) {
    warn "Exception when calling TopicApi->deleteTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicApi()
name = name_example # String | pass a required topic name for deleting that specific topic

try: 
    # Delete a topic item
    api_instance.delete_topic(name)
except ApiException as e:
    print("Exception when calling TopicApi->deleteTopic: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
pass a required topic name for deleting that specific topic
Required

Responses

Status: 204 - item deleted

Status: 404 - object not found


patchTopic

Updates a topic item

Update a topic item in the system


/TopicMod/{name}

Usage and SDK Samples

curl -X PATCH "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/TopicMod/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicApi;

import java.io.File;
import java.util.*;

public class TopicApiExample {

    public static void main(String[] args) {
        
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass a required topic name for updating that specific topic
        TopicItem body = ; // TopicItem | Topic item to update
        try {
            apiInstance.patchTopic(name, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#patchTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicApi;

public class TopicApiExample {

    public static void main(String[] args) {
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass a required topic name for updating that specific topic
        TopicItem body = ; // TopicItem | Topic item to update
        try {
            apiInstance.patchTopic(name, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#patchTopic");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // pass a required topic name for updating that specific topic
TopicItem *body = ; // Topic item to update (optional)

TopicApi *apiInstance = [[TopicApi alloc] init];

// Updates a topic item
[apiInstance patchTopicWith:name
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.TopicApi()
var name = name_example; // {{String}} pass a required topic name for updating that specific topic

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.patchTopic(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchTopicExample
    {
        public void main()
        {

            var apiInstance = new TopicApi();
            var name = name_example;  // String | pass a required topic name for updating that specific topic
            var body = new TopicItem(); // TopicItem | Topic item to update (optional) 

            try
            {
                // Updates a topic item
                apiInstance.patchTopic(name, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicApi.patchTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicApi();
$name = name_example; // String | pass a required topic name for updating that specific topic
$body = ; // TopicItem | Topic item to update

try {
    $api_instance->patchTopic($name, $body);
} catch (Exception $e) {
    echo 'Exception when calling TopicApi->patchTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicApi;

my $api_instance = WWW::SwaggerClient::TopicApi->new();
my $name = name_example; # String | pass a required topic name for updating that specific topic
my $body = WWW::SwaggerClient::Object::TopicItem->new(); # TopicItem | Topic item to update

eval { 
    $api_instance->patchTopic(name => $name, body => $body);
};
if ($@) {
    warn "Exception when calling TopicApi->patchTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicApi()
name = name_example # String | pass a required topic name for updating that specific topic
body =  # TopicItem | Topic item to update (optional)

try: 
    # Updates a topic item
    api_instance.patch_topic(name, body=body)
except ApiException as e:
    print("Exception when calling TopicApi->patchTopic: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
pass a required topic name for updating that specific topic
Required
Body parameters
Name Description
body

Responses

Status: 200 - item created, item updated

Status: 404 - object not found


searchTopic

Searches topics

By passing in the appropriate options, you can search for available topics in the system.


/Topics

Usage and SDK Samples

curl -X GET "https://virtserver.swaggerhub.com/SE-OER/SEOER-Backend-API/1.0.0/Topics?name=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicApi;

import java.io.File;
import java.util.*;

public class TopicApiExample {

    public static void main(String[] args) {
        
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass an optional search string for looking up a specific topic
        Integer offset = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[TopicItem] result = apiInstance.searchTopic(name, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#searchTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicApi;

public class TopicApiExample {

    public static void main(String[] args) {
        TopicApi apiInstance = new TopicApi();
        String name = name_example; // String | pass an optional search string for looking up a specific topic
        Integer offset = 56; // Integer | number of records to skip for pagination
        Integer limit = 56; // Integer | maximum number of records to return
        try {
            array[TopicItem] result = apiInstance.searchTopic(name, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicApi#searchTopic");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // pass an optional search string for looking up a specific topic (optional)
Integer *offset = 56; // number of records to skip for pagination (optional)
Integer *limit = 56; // maximum number of records to return (optional)

TopicApi *apiInstance = [[TopicApi alloc] init];

// Searches topics
[apiInstance searchTopicWith:name
    offset:offset
    limit:limit
              completionHandler: ^(array[TopicItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SeOerBackendApi = require('se_oer_backend_api');

var api = new SeOerBackendApi.TopicApi()
var opts = { 
  'name': name_example, // {{String}} pass an optional search string for looking up a specific topic
  'offset': 56, // {{Integer}} number of records to skip for pagination
  'limit': 56 // {{Integer}} maximum number of records to return
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTopic(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTopicExample
    {
        public void main()
        {

            var apiInstance = new TopicApi();
            var name = name_example;  // String | pass an optional search string for looking up a specific topic (optional) 
            var offset = 56;  // Integer | number of records to skip for pagination (optional) 
            var limit = 56;  // Integer | maximum number of records to return (optional) 

            try
            {
                // Searches topics
                array[TopicItem] result = apiInstance.searchTopic(name, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicApi.searchTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicApi();
$name = name_example; // String | pass an optional search string for looking up a specific topic
$offset = 56; // Integer | number of records to skip for pagination
$limit = 56; // Integer | maximum number of records to return

try {
    $result = $api_instance->searchTopic($name, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicApi->searchTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicApi;

my $api_instance = WWW::SwaggerClient::TopicApi->new();
my $name = name_example; # String | pass an optional search string for looking up a specific topic
my $offset = 56; # Integer | number of records to skip for pagination
my $limit = 56; # Integer | maximum number of records to return

eval { 
    my $result = $api_instance->searchTopic(name => $name, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicApi->searchTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicApi()
name = name_example # String | pass an optional search string for looking up a specific topic (optional)
offset = 56 # Integer | number of records to skip for pagination (optional)
limit = 56 # Integer | maximum number of records to return (optional)

try: 
    # Searches topics
    api_response = api_instance.search_topic(name=name, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicApi->searchTopic: %s\n" % e)

Parameters

Query parameters
Name Description
name
String
pass an optional search string for looking up a specific topic
offset
Integer (int32)
number of records to skip for pagination
limit
Integer (int32)
maximum number of records to return

Responses

Status: 200 - search results matching criteria