Package org.apache.fineract.client.services

Interface ScoreCardApi

public interface ScoreCardApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	createScorecard1(Long surveyId)	Create a Scorecard entry Add a new entry to a survey.
retrofit2.Call<Void>	createScorecard1(Long surveyId, Map<String,String> headers)	Create a Scorecard entry Add a new entry to a survey.
retrofit2.Call<Void>	createScorecard1(Long surveyId, ScorecardData scorecardData)	Create a Scorecard entry Add a new entry to a survey.
retrofit2.Call<Void>	createScorecard1(Long surveyId, ScorecardData scorecardData, Map<String,String> headers)	Create a Scorecard entry Add a new entry to a survey.
retrofit2.Call<List<ScorecardData>>	findByClient1(Long clientId)
retrofit2.Call<List<ScorecardData>>	findByClient1(Long clientId, Map<String,String> headers)
retrofit2.Call<List<Scorecard>>	findBySurvey(Long surveyId)	List all Scorecard entries List all Scorecard entries for a survey.
retrofit2.Call<List<Scorecard>>	findBySurvey(Long surveyId, Map<String,String> headers)	List all Scorecard entries List all Scorecard entries for a survey.
retrofit2.Call<List<ScorecardData>>	findBySurveyAndClient(Long surveyId, Long clientId)
retrofit2.Call<List<ScorecardData>>	findBySurveyAndClient(Long surveyId, Long clientId, Map<String,String> headers)

Method Details

createScorecard1

@Headers("Content-Type:application/json")
@POST("v1/surveys/scorecards/{surveyId}")
retrofit2.Call<Void> createScorecard1(@Path("surveyId")
 Long surveyId,
 @Body
 ScorecardData scorecardData)

Create a Scorecard entry Add a new entry to a survey. Mandatory Fields clientId, createdOn, questionId, responseId, staffId

Parameters:

surveyId - Enter surveyId (required)

scorecardData - scorecardData (optional)

Returns:

Call<Void>

findByClient1

@GET("v1/surveys/scorecards/clients/{clientId}")
retrofit2.Call<List<ScorecardData>> findByClient1(@Path("clientId")
 Long clientId)

Parameters:

clientId - (required)

Returns:

Call<List<ScorecardData>>

findBySurvey

@GET("v1/surveys/scorecards/{surveyId}")
retrofit2.Call<List<Scorecard>> findBySurvey(@Path("surveyId")
 Long surveyId)

List all Scorecard entries List all Scorecard entries for a survey.

Parameters:

surveyId - Enter surveyId (required)

Returns:

Call<List<Scorecard>>

findBySurveyAndClient

@GET("v1/surveys/scorecards/{surveyId}/clients/{clientId}")
retrofit2.Call<List<ScorecardData>> findBySurveyAndClient(@Path("surveyId")
 Long surveyId,
 @Path("clientId")
 Long clientId)

Parameters:

surveyId - Enter surveyId (required)

clientId - Enter clientId (required)

Returns:

Call<List<ScorecardData>>

createScorecard1

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

Create a Scorecard entry Add a new entry to a survey. Mandatory Fields clientId, createdOn, questionId, responseId, staffId

Parameters:

surveyId - Enter surveyId (required)

scorecardData - scorecardData (optional)

Returns:

Call<Void>

createScorecard1

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

Create a Scorecard entry Add a new entry to a survey. Mandatory Fields clientId, createdOn, questionId, responseId, staffId

Parameters:

surveyId - Enter surveyId (required)

scorecardData - scorecardData (optional)

Returns:

Call<Void>

findByClient1

@GET("v1/surveys/scorecards/clients/{clientId}")
retrofit2.Call<List<ScorecardData>> findByClient1(@Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

clientId - (required)

Returns:

Call<List<ScorecardData>>

findBySurvey

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

List all Scorecard entries List all Scorecard entries for a survey.

Parameters:

surveyId - Enter surveyId (required)

Returns:

Call<List<Scorecard>>

findBySurveyAndClient

@GET("v1/surveys/scorecards/{surveyId}/clients/{clientId}")
retrofit2.Call<List<ScorecardData>> findBySurveyAndClient(@Path("surveyId")
 Long surveyId,
 @Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

surveyId - Enter surveyId (required)

clientId - Enter clientId (required)

Returns:

Call<List<ScorecardData>>

createScorecard1

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

Create a Scorecard entry Add a new entry to a survey. Mandatory Fields clientId, createdOn, questionId, responseId, staffId

Parameters:

surveyId - Enter surveyId (required)

scorecardData - scorecardData (optional)

Returns:

Call<Void>