Package ch.examzone.sebbb.api

Class ExamsApi

java.lang.Object
ch.examzone.sebbb.api.ExamsApi
public class ExamsApi extends Object

  • Constructor Details

    • ExamsApi

      public ExamsApi()

    • ExamsApi

      public ExamsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • createExamCall

      public okhttp3.Call createExamCall(Exam exam, ApiCallback _callback) throws ApiException
      Build call for createExam
      Parameters:
      exam - Exam settings (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 Exam -
      422 Validation failed -

    • createExam

      public Exam createExam(Exam exam) throws ApiException
      Create an exam Returns the exam with its launch_url, the same sebbb:// link for all participants.
      Parameters:
      exam - Exam settings (required)
      Returns:
      Exam
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 Exam -
      422 Validation failed -

    • createExamWithHttpInfo

      public ApiResponse<Exam> createExamWithHttpInfo(Exam exam) throws ApiException
      Create an exam Returns the exam with its launch_url, the same sebbb:// link for all participants.
      Parameters:
      exam - Exam settings (required)
      Returns:
      ApiResponse<Exam>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 Exam -
      422 Validation failed -

    • createExamAsync

      public okhttp3.Call createExamAsync(Exam exam, ApiCallback<Exam> _callback) throws ApiException
      Create an exam (asynchronously) Returns the exam with its launch_url, the same sebbb:// link for all participants.
      Parameters:
      exam - Exam settings (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      201 Exam -
      422 Validation failed -

    • endExamCall

      public okhttp3.Call endExamCall(String id, ApiCallback _callback) throws ApiException
      Build call for endExam
      Parameters:
      id - Exam ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • endExam

      public Exam endExam(String id) throws ApiException
      End the exam Ends all sessions that are not ended yet and tells their apps to quit. New launches are refused.
      Parameters:
      id - Exam ID (required)
      Returns:
      Exam
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • endExamWithHttpInfo

      public ApiResponse<Exam> endExamWithHttpInfo(String id) throws ApiException
      End the exam Ends all sessions that are not ended yet and tells their apps to quit. New launches are refused.
      Parameters:
      id - Exam ID (required)
      Returns:
      ApiResponse<Exam>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • endExamAsync

      public okhttp3.Call endExamAsync(String id, ApiCallback<Exam> _callback) throws ApiException
      End the exam (asynchronously) Ends all sessions that are not ended yet and tells their apps to quit. New launches are refused.
      Parameters:
      id - Exam ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • getExamCall

      public okhttp3.Call getExamCall(String id, ApiCallback _callback) throws ApiException
      Build call for getExam
      Parameters:
      id - Exam ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • getExam

      public Exam getExam(String id) throws ApiException
      Get an exam with its current settings and launch_url
      Parameters:
      id - Exam ID (required)
      Returns:
      Exam
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • getExamWithHttpInfo

      public ApiResponse<Exam> getExamWithHttpInfo(String id) throws ApiException
      Get an exam with its current settings and launch_url
      Parameters:
      id - Exam ID (required)
      Returns:
      ApiResponse<Exam>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • getExamAsync

      public okhttp3.Call getExamAsync(String id, ApiCallback<Exam> _callback) throws ApiException
      Get an exam with its current settings and launch_url (asynchronously)
      Parameters:
      id - Exam ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -

    • listExamSessionsCall

      public okhttp3.Call listExamSessionsCall(String id, ApiCallback _callback) throws ApiException
      Build call for listExamSessions
      Parameters:
      id - Exam ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Sessions -
      404 Error -

    • listExamSessions

      public SessionList listExamSessions(String id) throws ApiException
      All sessions of the exam with state, participant reference and counters
      Parameters:
      id - Exam ID (required)
      Returns:
      SessionList
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Sessions -
      404 Error -

    • listExamSessionsWithHttpInfo

      public ApiResponse<SessionList> listExamSessionsWithHttpInfo(String id) throws ApiException
      All sessions of the exam with state, participant reference and counters
      Parameters:
      id - Exam ID (required)
      Returns:
      ApiResponse<SessionList>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Sessions -
      404 Error -

    • listExamSessionsAsync

      public okhttp3.Call listExamSessionsAsync(String id, ApiCallback<SessionList> _callback) throws ApiException
      All sessions of the exam with state, participant reference and counters (asynchronously)
      Parameters:
      id - Exam ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Sessions -
      404 Error -

    • startExamCall

      public okhttp3.Call startExamCall(String id, ApiCallback _callback) throws ApiException
      Build call for startExam
      Parameters:
      id - Exam ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      409 Exam already ended -

    • startExam

      public Exam startExam(String id) throws ApiException
      Start the exam Connected apps open the start_url. Apps registering later start right away. Repeating the call re-sends the start. Not needed with start_mode on_launch.
      Parameters:
      id - Exam ID (required)
      Returns:
      Exam
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      409 Exam already ended -

    • startExamWithHttpInfo

      public ApiResponse<Exam> startExamWithHttpInfo(String id) throws ApiException
      Start the exam Connected apps open the start_url. Apps registering later start right away. Repeating the call re-sends the start. Not needed with start_mode on_launch.
      Parameters:
      id - Exam ID (required)
      Returns:
      ApiResponse<Exam>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      409 Exam already ended -

    • startExamAsync

      public okhttp3.Call startExamAsync(String id, ApiCallback<Exam> _callback) throws ApiException
      Start the exam (asynchronously) Connected apps open the start_url. Apps registering later start right away. Repeating the call re-sends the start. Not needed with start_mode on_launch.
      Parameters:
      id - Exam ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      409 Exam already ended -

    • updateExamCall

      public okhttp3.Call updateExamCall(String id, Exam exam, ApiCallback _callback) throws ApiException
      Build call for updateExam
      Parameters:
      id - Exam ID (required)
      exam - Exam settings to change (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      422 Validation failed -

    • updateExam

      public Exam updateExam(String id, Exam exam) throws ApiException
      Change any exam setting Connected apps receive the new settings (e.g. allowed_urls) immediately.
      Parameters:
      id - Exam ID (required)
      exam - Exam settings to change (required)
      Returns:
      Exam
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      422 Validation failed -

    • updateExamWithHttpInfo

      public ApiResponse<Exam> updateExamWithHttpInfo(String id, Exam exam) throws ApiException
      Change any exam setting Connected apps receive the new settings (e.g. allowed_urls) immediately.
      Parameters:
      id - Exam ID (required)
      exam - Exam settings to change (required)
      Returns:
      ApiResponse<Exam>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      422 Validation failed -

    • updateExamAsync

      public okhttp3.Call updateExamAsync(String id, Exam exam, ApiCallback<Exam> _callback) throws ApiException
      Change any exam setting (asynchronously) Connected apps receive the new settings (e.g. allowed_urls) immediately.
      Parameters:
      id - Exam ID (required)
      exam - Exam settings to change (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Exam -
      404 Error -
      422 Validation failed -