1 package Koha::REST::V1::Libraries;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 3 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 use Mojo::Base 'Mojolicious::Controller';
23 use Scalar::Util qw( blessed );
29 Koha::REST::V1::Library - Koha REST API for handling libraries (V1)
39 Controller function that handles listing Koha::Library objects
44 my $c = shift->openapi->valid_input or return;
47 my $libraries_set = Koha::Libraries->new;
48 my $libraries = $c->objects->search( $libraries_set );
49 return $c->render( status => 200, openapi => $libraries );
52 unless ( blessed $_ && $_->can('rethrow') ) {
55 openapi => { error => "Something went wrong, check Koha logs for details." }
60 openapi => { error => "$_" }
67 Controller function that handles retrieving a single Koha::Library
72 my $c = shift->openapi->valid_input or return;
74 my $library_id = $c->validation->param('library_id');
75 my $library = Koha::Libraries->find( $library_id );
78 return $c->render( status => 404,
79 openapi => { error => "Library not found" } );
84 openapi => $library->to_api
90 Controller function that handles adding a new Koha::Library object
95 my $c = shift->openapi->valid_input or return;
98 my $library = Koha::Library->new_from_api( $c->validation->param('body') );
100 $c->res->headers->location( $c->req->url->to_string . '/' . $library->branchcode );
104 openapi => $library->to_api
108 unless ( blessed $_ && $_->can('rethrow') ) {
111 openapi => { error => "Something went wrong, check Koha logs for details." }
114 if ( $_->isa('Koha::Exceptions::Object::DuplicateID') ) {
117 openapi => { error => $_->error, conflict => $_->duplicate_id }
123 openapi => { error => "$_" }
131 Controller function that handles updating a Koha::Library object
136 my $c = shift->openapi->valid_input or return;
138 my $library = Koha::Libraries->find( $c->validation->param('library_id') );
140 if ( not defined $library ) {
143 openapi => { error => "Library not found" }
148 my $params = $c->req->json;
149 $library->set_from_api( $params );
153 openapi => $library->to_api
157 unless ( blessed $_ && $_->can('rethrow') ) {
160 openapi => { error => "Something went wrong, check Koha logs for details." }
166 openapi => { error => "$_" }
173 Controller function that handles deleting a Koha::Library object
179 my $c = shift->openapi->valid_input or return;
181 my $library = Koha::Libraries->find( $c->validation->param( 'library_id' ) );
183 if ( not defined $library ) {
184 return $c->render( status => 404, openapi => { error => "Library not found" } );
189 return $c->render( status => 204, openapi => '');
192 unless ( blessed $_ && $_->can('rethrow') ) {
195 openapi => { error => "Something went wrong, check Koha logs for details." }
201 openapi => { error => "$_" }