com.imsweb.seerapi.client.naaccr.NaaccrService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of seerapi-client-java Show documentation

API mapping for SEER*API in Java

There is a newer version: 5.7

/*
 * Copyright (C) 2015 Information Management Services, Inc.
 */
package com.imsweb.seerapi.client.naaccr;

import java.util.List;

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;

public interface NaaccrService {

    /**
     * Return a collection of NaaccrVersion objects which descibe the available versions
     * @return a list of the available NAACCR versions and information about each of them
     */
    @GET("naaccr/versions")
    Call> versions();

    /**
     * Return a list of all the field identifiers and names from a specified NAACCR version
     * @param version NAACCR version
     * @return a list of NaaccrFieldName objects
     */
    @GET("naaccr/{version}")
    Call> fieldNames(@Path("version") String version);

    /**
     * Return a list of all the field identifiers and names from a specified NAACCR version
     * @param version NAACCR version
     * @param item NAACCR item number
     * @return a list of NaaccrFieldName objects
     */
    @GET("naaccr/{version}/item/{item}")
    Call field(@Path("version") String version, @Path("item") Integer item);

}