com.imsweb.seerapi.client.naaccr

Interface NaaccrService

public interface NaaccrService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<NaaccrField>	field(java.lang.String version, java.lang.Integer item) Return a list of all the field identifiers and names from a specified NAACCR version
retrofit2.Call<java.util.List<NaaccrFieldName>>	fieldNames(java.lang.String version) Return a list of all the field identifiers and names from a specified NAACCR version
retrofit2.Call<java.util.List<NaaccrVersion>>	versions() Return a collection of NaaccrVersion objects which descibe the available versions

Method Detail

versions

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

Return a collection of NaaccrVersion objects which descibe the available versions

Returns:

a list of the available NAACCR versions and information about each of them

fieldNames

@GET(value="naaccr/{version}")
retrofit2.Call<java.util.List<NaaccrFieldName>> fieldNames(@Path(value="version")
                                                                                          java.lang.String version)

Return a list of all the field identifiers and names from a specified NAACCR version

Parameters:

version - NAACCR version

Returns:

a list of NaaccrFieldName objects

field

@GET(value="naaccr/{version}/item/{item}")
retrofit2.Call<NaaccrField> field(@Path(value="version")
                                                                             java.lang.String version,
                                                                             @Path(value="item")
                                                                             java.lang.Integer item)

Return a list of all the field identifiers and names from a specified NAACCR version

Parameters:

version - NAACCR version

item - NAACCR item number

Returns:

a list of NaaccrFieldName objects