Package org.apache.fineract.client.services

Interface SpmApiLookUpTableApi

public interface SpmApiLookUpTableApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	createLookupTable(Long surveyId)	Create a Lookup Table entry Add a new entry to a survey.
retrofit2.Call<Void>	createLookupTable(Long surveyId, Map<String,String> headers)	Create a Lookup Table entry Add a new entry to a survey.
retrofit2.Call<Void>	createLookupTable(Long surveyId, LookupTableData lookupTableData)	Create a Lookup Table entry Add a new entry to a survey.
retrofit2.Call<Void>	createLookupTable(Long surveyId, LookupTableData lookupTableData, Map<String,String> headers)	Create a Lookup Table entry Add a new entry to a survey.
retrofit2.Call<List<LookupTableData>>	fetchLookupTables(Long surveyId)	List all Lookup Table entries List all Lookup Table entries for a survey.
retrofit2.Call<List<LookupTableData>>	fetchLookupTables(Long surveyId, Map<String,String> headers)	List all Lookup Table entries List all Lookup Table entries for a survey.
retrofit2.Call<LookupTableData>	findLookupTable(Long surveyId, String key)	Retrieve a Lookup Table entry Retrieve a Lookup Table entry for a survey.
retrofit2.Call<LookupTableData>	findLookupTable(Long surveyId, String key, Map<String,String> headers)	Retrieve a Lookup Table entry Retrieve a Lookup Table entry for a survey.

Method Details

createLookupTable

@Headers("Content-Type:application/json")
@POST("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<Void> createLookupTable(@Path("surveyId")
 Long surveyId,
 @Body
 LookupTableData lookupTableData)

Create a Lookup Table entry Add a new entry to a survey. Mandatory Fields key, score, validFrom, validTo

Parameters:

surveyId - Enter surveyId (required)

lookupTableData - (optional)

Returns:

Call<Void>

fetchLookupTables

@GET("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<List<LookupTableData>> fetchLookupTables(@Path("surveyId")
 Long surveyId)

List all Lookup Table entries List all Lookup Table entries for a survey.

Parameters:

surveyId - Enter surveyId (required)

Returns:

Call<List<LookupTableData>>

findLookupTable

@GET("v1/surveys/{surveyId}/lookuptables/{key}")
retrofit2.Call<LookupTableData> findLookupTable(@Path("surveyId")
 Long surveyId,
 @Path("key")
 String key)

Retrieve a Lookup Table entry Retrieve a Lookup Table entry for a survey.

Parameters:

surveyId - Enter surveyId (required)

key - Enter key (required)

Returns:

Call<LookupTableData>

createLookupTable

@Headers("Content-Type:application/json")
@POST("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<Void> createLookupTable(@Path("surveyId")
 Long surveyId)

Create a Lookup Table entry Add a new entry to a survey. Mandatory Fields key, score, validFrom, validTo

Parameters:

surveyId - Enter surveyId (required)

lookupTableData - (optional)

Returns:

Call<Void>

createLookupTable

@Headers("Content-Type:application/json")
@POST("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<Void> createLookupTable(@Path("surveyId")
 Long surveyId,
 @Body
 LookupTableData lookupTableData,
 @HeaderMap
 Map<String,String> headers)

Create a Lookup Table entry Add a new entry to a survey. Mandatory Fields key, score, validFrom, validTo

Parameters:

surveyId - Enter surveyId (required)

lookupTableData - (optional)

Returns:

Call<Void>

fetchLookupTables

@GET("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<List<LookupTableData>> fetchLookupTables(@Path("surveyId")
 Long surveyId,
 @HeaderMap
 Map<String,String> headers)

List all Lookup Table entries List all Lookup Table entries for a survey.

Parameters:

surveyId - Enter surveyId (required)

Returns:

Call<List<LookupTableData>>

findLookupTable

@GET("v1/surveys/{surveyId}/lookuptables/{key}")
retrofit2.Call<LookupTableData> findLookupTable(@Path("surveyId")
 Long surveyId,
 @Path("key")
 String key,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Lookup Table entry Retrieve a Lookup Table entry for a survey.

Parameters:

surveyId - Enter surveyId (required)

key - Enter key (required)

Returns:

Call<LookupTableData>

createLookupTable

@Headers("Content-Type:application/json")
@POST("v1/surveys/{surveyId}/lookuptables")
retrofit2.Call<Void> createLookupTable(@Path("surveyId")
 Long surveyId,
 @HeaderMap
 Map<String,String> headers)

Create a Lookup Table entry Add a new entry to a survey. Mandatory Fields key, score, validFrom, validTo

Parameters:

surveyId - Enter surveyId (required)

lookupTableData - (optional)

Returns:

Call<Void>