nl.vpro.api.rs.v3.profile.ProfileRestService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-rs-services Show documentation

Contains the rest interfaces implemented by the Frontend API

There is a newer version: 8.3.0

/*
 * Copyright (C) 2013 Licensed under the Apache License, Version 2.0
 * VPRO The Netherlands
 */
package nl.vpro.api.rs.v3.profile;

import jakarta.ws.rs.*;
import jakarta.ws.rs.core.MediaType;

import nl.vpro.domain.api.profile.Profile;
import nl.vpro.domain.api.profile.ProfileResult;
import nl.vpro.jmx.Description;

/**
 * Simple service to view of inspect the available site profiles.
 *
 * @author Roelof Jan Koekoek
 * @since 2.0
 */
@Path(ProfileRestService.PATH)
@Produces({MediaType.APPLICATION_XML})
@Description("Services on https://rs.poms.omroep.nl/v1/api" + ProfileRestService.PATH)
public interface ProfileRestService {

    String TAG  = "profiles";
    String PATH = "/" + TAG;

    String NAME = "name";


    /**
     * Returns a site profile by its key
     *
     * @param name an profile identifier
     * @return an existing profile or an error when no profile is found
     */
    @GET
    @Path("/{name}")
    Profile load(
        @PathParam(NAME) String name);

    @GET
    @Path("/list")
    ProfileResult list(
        @QueryParam("pattern") String pattern,
        @QueryParam("max") Integer max
    );


}