Package org.apache.fineract.client.services

Interface SurveyApi

public interface SurveyApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostSurveySurveyNameApptableIdResponse>	createDatatableEntry1(String surveyName, Long apptableId, PostSurveySurveyNameApptableIdRequest postSurveySurveyNameApptableIdRequest)	Create an entry in the survey table Insert and entry in a survey table (full fill the survey).
retrofit2.Call<PostSurveySurveyNameApptableIdResponse>	createDatatableEntry1(String surveyName, Long apptableId, PostSurveySurveyNameApptableIdRequest postSurveySurveyNameApptableIdRequest, Map<String,String> headers)	Create an entry in the survey table Insert and entry in a survey table (full fill the survey).
retrofit2.Call<String>	deleteDatatableEntries1(String surveyName, Long clientId, Long fulfilledId)
retrofit2.Call<String>	deleteDatatableEntries1(String surveyName, Long clientId, Long fulfilledId, Map<String,String> headers)
retrofit2.Call<String>	getClientSurveyOverview(String surveyName, Long clientId)
retrofit2.Call<String>	getClientSurveyOverview(String surveyName, Long clientId, Map<String,String> headers)
retrofit2.Call<String>	getSurveyEntry(String surveyName, Long clientId, Long entryId)
retrofit2.Call<String>	getSurveyEntry(String surveyName, Long clientId, Long entryId, Map<String,String> headers)
retrofit2.Call<String>	register(String surveyName, String apptable)
retrofit2.Call<String>	register(String surveyName, String apptable, String body)
retrofit2.Call<String>	register(String surveyName, String apptable, String body, Map<String,String> headers)
retrofit2.Call<String>	register(String surveyName, String apptable, Map<String,String> headers)
retrofit2.Call<GetSurveyResponse>	retrieveSurvey(String surveyName)	Retrieve survey Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
retrofit2.Call<GetSurveyResponse>	retrieveSurvey(String surveyName, Map<String,String> headers)	Retrieve survey Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
retrofit2.Call<List<GetSurveyResponse>>	retrieveSurveys()	Retrieve surveys Retrieve surveys.
retrofit2.Call<List<GetSurveyResponse>>	retrieveSurveys(Map<String,String> headers)	Retrieve surveys Retrieve surveys.

Method Details

createDatatableEntry1

@Headers("Content-Type:application/json")
@POST("v1/survey/{surveyName}/{apptableId}")
retrofit2.Call<PostSurveySurveyNameApptableIdResponse> createDatatableEntry1(@Path("surveyName")
 String surveyName,
 @Path("apptableId")
 Long apptableId,
 @Body
 PostSurveySurveyNameApptableIdRequest postSurveySurveyNameApptableIdRequest)

Create an entry in the survey table Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://fineract.apache.org/docs/legacy/#survey_create ]

Parameters:

surveyName - surveyName (required)

apptableId - apptableId (required)

postSurveySurveyNameApptableIdRequest - (required)

Returns:

Call<PostSurveySurveyNameApptableIdResponse>

deleteDatatableEntries1

@DELETE("v1/survey/{surveyName}/{clientId}/{fulfilledId}")
retrofit2.Call<String> deleteDatatableEntries1(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId,
 @Path("fulfilledId")
 Long fulfilledId)

Parameters:

surveyName - (required)

clientId - (required)

fulfilledId - (required)

Returns:

Call<String>

getClientSurveyOverview

@GET("v1/survey/{surveyName}/{clientId}")
retrofit2.Call<String> getClientSurveyOverview(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId)

Parameters:

surveyName - (required)

clientId - (required)

Returns:

Call<String>

getSurveyEntry

@GET("v1/survey/{surveyName}/{clientId}/{entryId}")
retrofit2.Call<String> getSurveyEntry(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId,
 @Path("entryId")
 Long entryId)

Parameters:

surveyName - (required)

clientId - (required)

entryId - (required)

Returns:

Call<String>

register

@Headers("Content-Type:application/json")
@PUT("v1/survey/register/{surveyName}/{apptable}")
retrofit2.Call<String> register(@Path("surveyName")
 String surveyName,
 @Path("apptable")
 String apptable,
 @Body
 String body)

Parameters:

surveyName - (required)

apptable - (required)

body - (optional)

Returns:

Call<String>

retrieveSurvey

@GET("v1/survey/{surveyName}")
retrofit2.Call<GetSurveyResponse> retrieveSurvey(@Path("surveyName")
 String surveyName)

Retrieve survey Lists a registered survey table details and the Apache Fineract Core application table they are registered to.

Parameters:

surveyName - surveyName (required)

Returns:

Call<GetSurveyResponse>

retrieveSurveys

@GET("v1/survey")
retrofit2.Call<List<GetSurveyResponse>> retrieveSurveys()

Retrieve surveys Retrieve surveys. This allows to retrieve the list of survey tables registered .

Returns:

Call<List<GetSurveyResponse>>

register

@Headers("Content-Type:application/json")
@PUT("v1/survey/register/{surveyName}/{apptable}")
retrofit2.Call<String> register(@Path("surveyName")
 String surveyName,
 @Path("apptable")
 String apptable)

Parameters:

surveyName - (required)

apptable - (required)

body - (optional)

Returns:

Call<String>

createDatatableEntry1

@Headers("Content-Type:application/json")
@POST("v1/survey/{surveyName}/{apptableId}")
retrofit2.Call<PostSurveySurveyNameApptableIdResponse> createDatatableEntry1(@Path("surveyName")
 String surveyName,
 @Path("apptableId")
 Long apptableId,
 @Body
 PostSurveySurveyNameApptableIdRequest postSurveySurveyNameApptableIdRequest,
 @HeaderMap
 Map<String,String> headers)

Create an entry in the survey table Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://fineract.apache.org/docs/legacy/#survey_create ]

Parameters:

surveyName - surveyName (required)

apptableId - apptableId (required)

postSurveySurveyNameApptableIdRequest - (required)

Returns:

Call<PostSurveySurveyNameApptableIdResponse>

deleteDatatableEntries1

@DELETE("v1/survey/{surveyName}/{clientId}/{fulfilledId}")
retrofit2.Call<String> deleteDatatableEntries1(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId,
 @Path("fulfilledId")
 Long fulfilledId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyName - (required)

clientId - (required)

fulfilledId - (required)

Returns:

Call<String>

getClientSurveyOverview

@GET("v1/survey/{surveyName}/{clientId}")
retrofit2.Call<String> getClientSurveyOverview(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyName - (required)

clientId - (required)

Returns:

Call<String>

getSurveyEntry

@GET("v1/survey/{surveyName}/{clientId}/{entryId}")
retrofit2.Call<String> getSurveyEntry(@Path("surveyName")
 String surveyName,
 @Path("clientId")
 Long clientId,
 @Path("entryId")
 Long entryId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyName - (required)

clientId - (required)

entryId - (required)

Returns:

Call<String>

register

@Headers("Content-Type:application/json")
@PUT("v1/survey/register/{surveyName}/{apptable}")
retrofit2.Call<String> register(@Path("surveyName")
 String surveyName,
 @Path("apptable")
 String apptable,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyName - (required)

apptable - (required)

body - (optional)

Returns:

Call<String>

retrieveSurvey

@GET("v1/survey/{surveyName}")
retrofit2.Call<GetSurveyResponse> retrieveSurvey(@Path("surveyName")
 String surveyName,
 @HeaderMap
 Map<String,String> headers)

Retrieve survey Lists a registered survey table details and the Apache Fineract Core application table they are registered to.

Parameters:

surveyName - surveyName (required)

Returns:

Call<GetSurveyResponse>

retrieveSurveys

@GET("v1/survey")
retrofit2.Call<List<GetSurveyResponse>> retrieveSurveys(@HeaderMap
 Map<String,String> headers)

Retrieve surveys Retrieve surveys. This allows to retrieve the list of survey tables registered .

Returns:

Call<List<GetSurveyResponse>>

register

@Headers("Content-Type:application/json")
@PUT("v1/survey/register/{surveyName}/{apptable}")
retrofit2.Call<String> register(@Path("surveyName")
 String surveyName,
 @Path("apptable")
 String apptable,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyName - (required)

apptable - (required)

body - (optional)

Returns:

Call<String>