net.n2oapp.security.admin.rest.api.OrganizationPersistRestService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of security-admin-rest-api Show documentation

There is a newer version: 8.0.1

Show newest version

package net.n2oapp.security.admin.rest.api;

import io.swagger.annotations.*;
import net.n2oapp.security.admin.api.model.Organization;

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

/**
 * REST сервис для создание, изменения и удаления организаций
 */
@Path("/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Api(value = "Организации", authorizations = @Authorization(value = "oauth2"))
public interface OrganizationPersistRestService {

    @POST
    @Path("/organizations")
    @ApiOperation("Создать организацию")
    @ApiResponse(code = 200, message = "Организация создана")
    Organization create(@ApiParam("Организация") Organization organization);

    @PUT
    @Path("/organizations")
    @ApiOperation("Обновить организацию")
    @ApiResponse(code = 200, message = "Организация обновлена")
    Organization update(@ApiParam("Организация") Organization organization);

    @DELETE
    @Path("/organizations/{id}")
    @ApiOperation("Удалить организацию")
    @ApiResponse(code = 200, message = "Организация удалена")
    void delete(@ApiParam(value = "Уникальный идентификатор записи организации") @PathParam("id") Integer id);
}