com.imsweb.seerapi.client.rx

Interface RxService

public interface RxService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<RxChangelogResults>	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<Rx>	getById(java.lang.String version, java.lang.String id) Return a complete Rx entity based in identifier
retrofit2.Call<Rx>	getById(java.lang.String version, java.lang.String id, boolean includeGlossary) Return a complete Rx entity based in identifier
retrofit2.Call<RxSearchResults>	search(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> searchParams) Return a list of matching Rx entities
retrofit2.Call<RxSearchResults>	search(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> searchParams, java.util.Set<java.lang.String> categories) Return a list of matching Rx entities
retrofit2.Call<RxSearchResults>	search(java.lang.String version, java.lang.String query) Return a list of matching Rx entities
retrofit2.Call<RxSearchResults>	search(java.lang.String version, java.lang.String query, java.util.Set<java.lang.String> categories) Return a list of matching Rx entities
retrofit2.Call<java.util.List<RxVersion>>	versions() Return a list of all Rx versions and information about them.

Method Detail

versions

@GET(value="rx/versions")
retrofit2.Call<java.util.List<RxVersion>> versions()

Return a list of all Rx versions and information about them. Note that by default the Rx entity does not include relevant glossary references.

Returns:

a list of RxVersion objects

getById

@GET(value="rx/{version}/id/{id}")
retrofit2.Call<Rx> getById(@Path(value="version")
                                                              java.lang.String version,
                                                              @Path(value="id")
                                                              java.lang.String id)

Return a complete Rx entity based in identifier

Parameters:

version - Rx version

id - Rx identifier

Returns:

a Rx object

getById

@GET(value="rx/{version}/id/{id}")
retrofit2.Call<Rx> getById(@Path(value="version")
                                                              java.lang.String version,
                                                              @Path(value="id")
                                                              java.lang.String id,
                                                              @Query(value="glossary")
                                                              boolean includeGlossary)

Return a complete Rx entity based in identifier

Parameters:

version - Rx version

id - Rx identifier

includeGlossary - if true, include the glossary

Returns:

a Rx object

search

@GET(value="rx/{version}")
retrofit2.Call<RxSearchResults> search(@Path(value="version")
                                                                  java.lang.String version,
                                                                  @Query(value="q")
                                                                  java.lang.String query)

Return a list of matching Rx entities

Parameters:

version - Rx version

query - search query

Returns:

a RxSearchResults object

search

@GET(value="rx/{version}")
retrofit2.Call<RxSearchResults> search(@Path(value="version")
                                                                  java.lang.String version,
                                                                  @Query(value="q")
                                                                  java.lang.String query,
                                                                  @Query(value="category")
                                                                  java.util.Set<java.lang.String> categories)

Return a list of matching Rx entities

Parameters:

version - Rx version

query - search query

categories - limit to these categories

Returns:

a RxSearchResults object

search

@GET(value="rx/{version}")
retrofit2.Call<RxSearchResults> search(@Path(value="version")
                                                                  java.lang.String version,
                                                                  @QueryMap
                                                                  java.util.Map<java.lang.String,java.lang.String> searchParams)

Return a list of matching Rx entities

Parameters:

version - Rx version

searchParams - A Map of search parameters. Use RxSearch to easily build parameter list.

Returns:

a RxSearchResults object

search

@GET(value="rx/{version}")
retrofit2.Call<RxSearchResults> 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<java.lang.String> categories)

Return a list of matching Rx entities

Parameters:

version - Rx version

searchParams - A Map of search parameters. Use RxSearch to easily build parameter list.

categories - limit to these categories

Returns:

a RxSearchResults object

changelogs

@GET(value="rx/{version}/changelog")
retrofit2.Call<RxChangelogResults> 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)

Return the changelog entries for the passed database version

Parameters:

version - Rx version

fromDate - 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

Returns:

a list of RxChangelogResults objects