com.blockscore.net

Interface BlockscoreRestAdapter

public interface BlockscoreRestAdapter

The Blockscore API Retrofit REST adapter.

Method Summary

Modifier and Type	Method and Description
Candidate	createCandidate(Candidate candidate)
Company	createCompany(java.util.Map<java.lang.String,java.lang.String> options)
Person	createPerson(java.util.Map<java.lang.String,java.lang.String> options)
QuestionSet	createQuestionSet(java.util.Map<java.lang.String,java.lang.String> options)
Candidate	deleteCandidate(java.lang.String id)
java.util.List<Candidate>	getCandidateHistory(java.lang.String id)
PaginatedResult<WatchlistHit>	getCandidateHits(java.lang.String id)
PaginatedResult<Candidate>	listCandidates()
PaginatedResult<Company>	listCompanies()
PaginatedResult<Person>	listPeople()
Candidate	retrieveCandidate(java.lang.String id)
Company	retrieveCompany(java.lang.String companyId)
Person	retrievePerson(java.lang.String id)
QuestionSet	retrieveQuestionSet(java.lang.String questionSetId)
QuestionSet	scoreQuestionSet(java.lang.String questionSetId, AnswerSet answers)
WatchlistSearchResults	searchWatchlists(java.util.Map<java.lang.String,java.lang.String> options)
Candidate	updateCandidate(java.lang.String id, Candidate candidate)

Method Detail

createPerson

@NotNull
 @POST(value="/people")
Person createPerson(@NotNull @QueryMap
                                                     java.util.Map<java.lang.String,java.lang.String> options)

retrievePerson

@NotNull
 @GET(value="/people/{id}")
Person retrievePerson(@NotNull @Path(value="id")
                                                           java.lang.String id)

listPeople

@NotNull
 @GET(value="/people")
PaginatedResult<Person> listPeople()

createQuestionSet

@NotNull
 @POST(value="/question_sets")
QuestionSet createQuestionSet(@NotNull @QueryMap
                                                                      java.util.Map<java.lang.String,java.lang.String> options)

scoreQuestionSet

@NotNull
 @POST(value="/question_sets/{id}/score")
QuestionSet scoreQuestionSet(@Path(value="id") @NotNull
                                                                                java.lang.String questionSetId,
                                                                                @NotNull @Body
                                                                                AnswerSet answers)

retrieveQuestionSet

@NotNull
 @GET(value="/question_sets/{id}")
QuestionSet retrieveQuestionSet(@Path(value="id") @NotNull
                                                                            java.lang.String questionSetId)

createCompany

@POST(value="/companies")
Company createCompany(@NotNull @QueryMap
                                                java.util.Map<java.lang.String,java.lang.String> options)

retrieveCompany

@NotNull
 @GET(value="/companies/{id}")
Company retrieveCompany(@Path(value="id") @NotNull
                                                                java.lang.String companyId)

listCompanies

@NotNull
 @GET(value="/companies")
PaginatedResult<Company> listCompanies()

createCandidate

@NotNull
 @POST(value="/candidates")
Candidate createCandidate(@NotNull @Body
                                                               Candidate candidate)

retrieveCandidate

@NotNull
 @GET(value="/candidates/{id}")
Candidate retrieveCandidate(@NotNull @Path(value="id")
                                                                     java.lang.String id)

updateCandidate

@NotNull
 @PATCH(value="/candidates/{id}")
Candidate updateCandidate(@NotNull @Path(value="id")
                                                                     java.lang.String id,
                                                                     @NotNull @Body
                                                                     Candidate candidate)

deleteCandidate

@NotNull
 @DELETE(value="/candidates/{id}")
Candidate deleteCandidate(@NotNull @Path(value="id")
                                                                      java.lang.String id)

listCandidates

@NotNull
 @GET(value="/candidates")
PaginatedResult<Candidate> listCandidates()

getCandidateHistory

@NotNull
 @GET(value="/candidates/{id}/history")
java.util.List<Candidate> getCandidateHistory(@NotNull @Path(value="id")
                                                                                               java.lang.String id)

getCandidateHits

@NotNull
 @GET(value="/candidates/{id}/hits")
PaginatedResult<WatchlistHit> getCandidateHits(@NotNull @Path(value="id")
                                                                                             java.lang.String id)

searchWatchlists

@NotNull
 @POST(value="/watchlists")
WatchlistSearchResults searchWatchlists(@NotNull @QueryMap
                                                                             java.util.Map<java.lang.String,java.lang.String> options)