Package org.apache.fineract.client.services

Interface SpmSurveysApi

public interface SpmSurveysApi

  • Method Details

    • activateOrDeactivateSurvey

      @POST("v1/surveys/{id}") retrofit2.Call<Void> activateOrDeactivateSurvey(@Path("id") Long id, @Query("command") String command)
      Deactivate Survey
      Parameters:
      id - (required)
      command - (optional)
      Returns:
      Call<Void>

    • createSurvey

      @Headers("Content-Type:application/json") @POST("v1/surveys") retrofit2.Call<Void> createSurvey(@Body SurveyData surveyData)
      Create a Survey Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
      Parameters:
      surveyData - Create survey (optional)
      Returns:
      Call<Void>

    • editSurvey

      @Headers("Content-Type:application/json") @PUT("v1/surveys/{id}") retrofit2.Call<String> editSurvey(@Path("id") Long id, @Body SurveyData surveyData)
      Parameters:
      id - (required)
      surveyData - (optional)
      Returns:
      Call<String>

    • fetchAllSurveys1

      @GET("v1/surveys") retrofit2.Call<List<SurveyData>> fetchAllSurveys1(@Query("isActive") Boolean isActive)
      List all Surveys
      Parameters:
      isActive - (optional)
      Returns:
      Call<List<SurveyData>>

    • findSurvey

      @GET("v1/surveys/{id}") retrofit2.Call<SurveyData> findSurvey(@Path("id") Long id)
      Retrieve a Survey
      Parameters:
      id - Enter id (required)
      Returns:
      Call<SurveyData>

    • createSurvey

      @Headers("Content-Type:application/json") @POST("v1/surveys") retrofit2.Call<Void> createSurvey()
      Create a Survey Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
      Parameters:
      surveyData - Create survey (optional)
      Returns:
      Call<Void>

    • editSurvey

      @Headers("Content-Type:application/json") @PUT("v1/surveys/{id}") retrofit2.Call<String> editSurvey(@Path("id") Long id)
      Parameters:
      id - (required)
      surveyData - (optional)
      Returns:
      Call<String>

    • activateOrDeactivateSurvey

      @POST("v1/surveys/{id}") retrofit2.Call<Void> activateOrDeactivateSurvey(@Path("id") Long id, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Deactivate Survey
      Parameters:
      id - (required)
      command - (optional)
      Returns:
      Call<Void>

    • createSurvey

      @Headers("Content-Type:application/json") @POST("v1/surveys") retrofit2.Call<Void> createSurvey(@Body SurveyData surveyData, @HeaderMap Map<String,String> headers)
      Create a Survey Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
      Parameters:
      surveyData - Create survey (optional)
      Returns:
      Call<Void>

    • editSurvey

      @Headers("Content-Type:application/json") @PUT("v1/surveys/{id}") retrofit2.Call<String> editSurvey(@Path("id") Long id, @Body SurveyData surveyData, @HeaderMap Map<String,String> headers)
      Parameters:
      id - (required)
      surveyData - (optional)
      Returns:
      Call<String>

    • fetchAllSurveys1

      @GET("v1/surveys") retrofit2.Call<List<SurveyData>> fetchAllSurveys1(@Query("isActive") Boolean isActive, @HeaderMap Map<String,String> headers)
      List all Surveys
      Parameters:
      isActive - (optional)
      Returns:
      Call<List<SurveyData>>

    • findSurvey

      @GET("v1/surveys/{id}") retrofit2.Call<SurveyData> findSurvey(@Path("id") Long id, @HeaderMap Map<String,String> headers)
      Retrieve a Survey
      Parameters:
      id - Enter id (required)
      Returns:
      Call<SurveyData>

    • createSurvey

      @Headers("Content-Type:application/json") @POST("v1/surveys") retrofit2.Call<Void> createSurvey(@HeaderMap Map<String,String> headers)
      Create a Survey Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
      Parameters:
      surveyData - Create survey (optional)
      Returns:
      Call<Void>

    • editSurvey

      @Headers("Content-Type:application/json") @PUT("v1/surveys/{id}") retrofit2.Call<String> editSurvey(@Path("id") Long id, @HeaderMap Map<String,String> headers)
      Parameters:
      id - (required)
      surveyData - (optional)
      Returns:
      Call<String>