public interface GlossaryService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<GlossaryChangelogResults> |
changelogs(java.lang.String version,
java.lang.String fromDate,
java.lang.String toDate,
java.lang.Integer count)
Return the changelog entries for the passed database version
|
retrofit2.Call<Glossary> |
getById(java.lang.String version,
java.lang.String id)
Return a complete glossary entity based in identifier
|
retrofit2.Call<GlossarySearchResults> |
search(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> searchParams)
Return a list of matching glossaries
|
retrofit2.Call<GlossarySearchResults> |
search(java.lang.String version,
java.util.Map<java.lang.String,java.lang.String> searchParams,
java.util.Set<Glossary.Category> categories)
Return a list of matching glossaries
|
retrofit2.Call<GlossarySearchResults> |
search(java.lang.String version,
java.lang.String query)
Return a list of matching glossaries
|
retrofit2.Call<GlossarySearchResults> |
search(java.lang.String version,
java.lang.String query,
java.util.Set<Glossary.Category> categories)
Return a list of matching glossaries
|
retrofit2.Call<java.util.List<GlossaryVersion>> |
versions()
Return a list of all glossary versions and information about them
|
@GET(value="glossary/versions") retrofit2.Call<java.util.List<GlossaryVersion>> versions()
@GET(value="glossary/{version}/id/{id}")
retrofit2.Call<Glossary> getById(@Path(value="version")
java.lang.String version,
@Path(value="id")
java.lang.String id)
version - Glossary versionid - Glossary identifier@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
java.lang.String version,
@Query(value="q")
java.lang.String query)
version - Glossary versionquery - search query@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
java.lang.String version,
@Query(value="q")
java.lang.String query,
@Query(value="category")
java.util.Set<Glossary.Category> categories)
version - Glossary versionquery - search querycategories - a list of categories@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
java.lang.String version,
@QueryMap
java.util.Map<java.lang.String,java.lang.String> searchParams)
version - Glossary versionsearchParams - A Map of search parameters. Use GlossarySearch to easily build parameter list.@GET(value="glossary/{version}")
retrofit2.Call<GlossarySearchResults> search(@Path(value="version")
java.lang.String version,
@QueryMap
java.util.Map<java.lang.String,java.lang.String> searchParams,
@Query(value="category")
java.util.Set<Glossary.Category> categories)
version - Glossary versionsearchParams - A Map of search parameters. Use GlossarySearch to easily build parameter list.categories - a list of categories@GET(value="glossary/{version}/changelog")
retrofit2.Call<GlossaryChangelogResults> changelogs(@Path(value="version")
java.lang.String version,
@Query(value="from")
java.lang.String fromDate,
@Query(value="to")
java.lang.String toDate,
@Query(value="count")
java.lang.Integer count)
version - Glossary versionfromDate - if not null, only include changes from this date forward (YYYY-MM-DD)toDate - if not null, only include changes prior to this date (YYYY-MM-DD)count - if not null, limit the number returned