com.smartling.api.locales.v2.LocalesApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartling-locales-api Show documentation

There is a newer version: 1.16.0

Show newest version

package com.smartling.api.locales.v2;

import com.smartling.api.locales.v2.pto.LocalePTO;
import com.smartling.api.v2.response.ListResponse;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.List;

@Path("/locales-api/v2")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface LocalesApi
{
    /**
     * Returns a list of all locales used by Smartling.
     *
     * 
     *     The list of returned locales may be filtered by providing a list of
     *     locale identifiers to return.
     * 
     *
     * @param localeIds list of desired locales to return, if null or empty, all
     *                  locales will be returned
     * @return list of locales
     */
    @GET
    @Path("/dictionary/locales")
    ListResponse getLocalesAsDictionary(@QueryParam("localeIds") List localeIds);

    /**
     * Returns a list of all locales used by Smartling.
     *
     * 
     *     The list of returned locales may be filtered by providing a list of
     *     locale identifiers to return and a boolean to indicate if only Smartling supported
     *     locales should be returned.
     * 
     *
     * @param localeIds list of desired locales to return, if null or empty, all
     *                  locales will be returned
     * @param supportedOnly true if only supported locales should be returned;
     *                      false or null otherwise
     * @return list of locales
     */
    @GET
    @Path("/dictionary/locales")
    ListResponse getLocalesAsDictionary(@QueryParam("localeIds") List localeIds, @QueryParam("supportedOnly") Boolean supportedOnly);
}