swagger-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basic-auth
        HttpBasicAuth basic-auth = (HttpBasicAuth) defaultClient.getAuthentication("basic-auth");
        basic-auth.setUsername("YOUR USERNAME");
        basic-auth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String replyInputSourceId = "replyInputSourceId_example"; // String | 
        try {
            StudentQuestion result = apiInstance.deleteBestAnswer(replyInputSourceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteBestAnswer");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Class	Method	HTTP request	Description
DefaultApi	deleteBestAnswer	DELETE /bot/question/bestAnswer/{replyInputSourceId}	delete bestAnswer
DefaultApi	deleteQuestion	DELETE /bot/question	deletes a given Question
DefaultApi	deleteQuestionByInputSourceId	DELETE /bot/question/sourceId/{inputSourceId}	deletes a given Question by using its inputSourceId
DefaultApi	deleteQuestionByInputSourceIdandInputSource	DELETE /bot/question/sourceId/{inputSourceId}/source/{inputSource}	deletes a given Question by using its inputSourceId and inputSource
DefaultApi	deleteReply	DELETE /bot/reply/{inputSourceId}	deletes a reply by its inputSourceId
DefaultApi	downvote	GET /bot/downvote/{inputSourceId}/userId/{userId}	upvotes a given DataItem using its inputSourceId
DefaultApi	getActiveSlides	GET /bot/slide/live	Returns an Array of active slides for (ppt, key, and dev)
DefaultApi	getAdminAnswer	POST /bot/answer	forwards a new Admin Answer
DefaultApi	getAllBots	GET /bot/bot	retrieves all bots
DefaultApi	getAllClosedStudentQuestionsForExercises	GET /bot/question/exercise/report	retrieves all exercise questions report not including general questions - ordered by slideSet
DefaultApi	getAllClosedStudentQuestionsForLectures	GET /bot/question/lecture/report	retrieves all lecture questions report not including general questions - ordered by slideSet
DefaultApi	getAllPresenterSessions	GET /bot/presenter	Retrieves all Presenters
DefaultApi	getAllQuestionWallSessions	GET /bot/wall	retrieves all question wall listeners
DefaultApi	getAllStudentQuestions	GET /bot/question	retrieves all Questions
DefaultApi	getAllStudentQuestionsByInputSource	GET /bot/question/inputSource/{inputSource}	retrieves all Questions
DefaultApi	getClosedLastNumStudentQuestions	GET /bot/question/closed/last/{num}	retrieves last {num} closed Questions
DefaultApi	getClosedStudentQuestions	GET /bot/question/closed	retrieves closed Questions
DefaultApi	getExercises	GET /bot/exercise	Returns a mapping ordered by timestamp of all exerciseNames
DefaultApi	getLastNumTeacherQuestions	GET /bot/quiz/last/{num}	retrieves last {num} quizzes
DefaultApi	getOpenQuestions	GET /bot/question/open	retrieves open Questions
DefaultApi	getPresentations	GET /bot/presentation	Returns a mapping ordered by timestamp of all presentationNames
DefaultApi	getQuestionByInputSourceId	GET /bot/question/sourceId/{inputSourceId}	retrieves question by its InputSourceId
DefaultApi	getQuestionByInputSourceIdandInputSource	GET /bot/question/sourceId/{inputSourceId}/source/{inputSource}	retrieves question by its InputSourceId and inputSource
DefaultApi	getQuestionByObjectId	GET /bot/question/{id}	retrieves question by its ObjectId
DefaultApi	getQuestionByReplyInputSourceId	GET /bot/question/reply/sourceId/{inputSourceId}	retrieves question by looking for a certain reply.inputSourceId
DefaultApi	getReplyByInputSourceId	GET /bot/reply/sourceId/{inputSourceId}	retrieves reply by looking for a certain reply.inputSourceId
DefaultApi	getReplyForQuestionByContent	GET /bot/question/sourceId/{inputSourceId}/reply/content/{content}	retrieves reply by looking for a certain reply.content
DefaultApi	getReportForExercise	GET /bot/question/report/exercise{num}	retrieves all questions report for specific exercise(slideSet)
DefaultApi	getReportForGeneral	GET /bot/question/report/general	retrieves all questions report for specific lecture(slideSet)
DefaultApi	getReportForLecture	GET /bot/question/report/lecture/{num}	retrieves all questions report for specific lecture(slideSet)
DefaultApi	getSMSQuestion	POST /bot/sms	forwards a new SMS question
DefaultApi	getScoreforInputSource	GET /bot/score/inputSource/{inputSource}	generates Highscore for a given InputSource
DefaultApi	getSlideForExerciseNumberAndSlideNumber	GET /bot/exercise/number/{exerciseNumber}/slide/number/{slideNumber}	Returns slidePath for ExerciseNumber / SlideNumber
DefaultApi	getSlideForPresentationNumberAndSlideNumber	GET /bot/presentation/number/{presentationNumber}/slide/number/{slideNumber}	Returns slidePath for PresentationNumber / SlideNumber
DefaultApi	getSlidesForExerciseName	GET /bot/exercise/name/{exerciseName}/slide	Returns all Slides for ExerciseName
DefaultApi	getSlidesForPresentationName	GET /bot/presentation/name/{presentationName}/slide	Returns all Slides for PresentationName
DefaultApi	getWhatsappQuestion	POST /bot/whatsapp	forwards a new Whatsapp question
DefaultApi	postBestAnswer	POST /bot/question/bestAnswer/{replyInputSourceId}	saves a bestAnswer
DefaultApi	postFeedback	POST /bot/feedback	saves a new Feedback, updates it if already existent
DefaultApi	postQuestion	POST /bot/question	saves a new Question, updates it if already existent
DefaultApi	postReply	POST /bot/question/{questionInputSourceId}/reply	saves a new Reply, updates it if already existent
DefaultApi	putQuestion	PUT /bot/question	saves a new Question, updates it if already existent
DefaultApi	putQuiz	PUT /bot/quiz	saves a new Quiz
DefaultApi	upvote	GET /bot/upvote/{inputSourceId}/userId/{userId}	upvotes a given DataItem using its inputSourceId

Documentation for Models

• Score

Documentation for Authorization

Authentication schemes defined for the API:

basic-auth

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author