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
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Mojo::Base 'Mojolicious::Controller';
23 use Scalar::Util qw( blessed );
25 use Try::Tiny qw( catch try );
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 = $c->objects->search( Koha::Libraries->new );
48 return $c->render( status => 200, openapi => $libraries );
51 $c->unhandled_exception($_);
57 Controller function that handles retrieving a single Koha::Library
62 my $c = shift->openapi->valid_input or return;
65 my $library = Koha::Libraries->find( $c->param('library_id') );
70 openapi => { error => "Library not found" }
76 openapi => $library->to_api
80 $c->unhandled_exception($_);
86 Controller function that handles adding a new Koha::Library object
91 my $c = shift->openapi->valid_input or return;
94 my $library = Koha::Library->new_from_api( $c->req->json );
96 $c->res->headers->location( $c->req->url->to_string . '/' . $library->branchcode );
100 openapi => $c->objects->to_api($library),
104 if ( blessed $_ && $_->isa('Koha::Exceptions::Object::DuplicateID') ) {
107 openapi => { error => $_->error, conflict => $_->duplicate_id }
111 $c->unhandled_exception($_);
117 Controller function that handles updating a Koha::Library object
122 my $c = shift->openapi->valid_input or return;
124 my $library = Koha::Libraries->find( $c->param('library_id') );
126 if ( not defined $library ) {
129 openapi => { error => "Library not found" }
134 my $params = $c->req->json;
135 $library->set_from_api( $params );
139 openapi => $c->objects->to_api($library),
143 $c->unhandled_exception($_);
149 Controller function that handles deleting a Koha::Library object
155 my $c = shift->openapi->valid_input or return;
157 my $library = Koha::Libraries->find( $c->param( 'library_id' ) );
159 if ( not defined $library ) {
160 return $c->render( status => 404, openapi => { error => "Library not found" } );
165 return $c->render( status => 204, openapi => '');
168 $c->unhandled_exception($_);
174 Controller function that handles retrieving the library's desks
179 my $c = shift->openapi->valid_input or return;
181 return $c->render( status => 404, openapi => { error => "Feature disabled" } )
182 unless C4::Context->preference('UseCirculationDesks');
185 my $library = Koha::Libraries->find( $c->param('library_id') );
190 openapi => { error => "Library not found" }
196 openapi => $c->objects->to_api( $library->desks )
199 $c->unhandled_exception($_);
203 =head3 list_cash_registers
205 Controller function that handles retrieving the library's cash registers
209 sub list_cash_registers {
210 my $c = shift->openapi->valid_input or return;
212 return $c->render( status => 404, openapi => { error => "Feature disabled" } )
213 unless C4::Context->preference('UseCashRegisters');
216 my $library = Koha::Libraries->find( $c->param('library_id') );
221 openapi => { error => "Library not found" }
227 openapi => $c->objects->to_api( $library->cash_registers )
230 $c->unhandled_exception($_);