Bug 17981: (QA follow-up) Fix and update pod in svc/letters/get
[koha.git] / svc / letters / get
blob708de7425ea2f1ac922dee08391569900b5e88f8
1 #!/usr/bin/perl
3 # This file is part of Koha.
5 # Copyright 2014 BibLibre
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Modern::Perl;
22 use C4::Service;
23 use C4::Letters qw( GetLetters );
25 =head1 NAME
27 svc/letters/get - Web service for getting letters
29 =head1 SYNOPSIS
31 GET /svc/letters/get
33 =head1 DESCRIPTION
35 For the moment, this service is only used to get a letter from a letter code.
37 =head1 METHODS
39 =cut
41 =head2 get_letters
43 Used to get letters with a given letter code.
45 =cut
47 our ( $query, $response ) = C4::Service->init( tools => 'edit_notices' );
49 sub get_letters {
50 my $letters = GetLetters({ code => $query->param('code'), branchcode => $query->param('branchcode') });
51 $response->param( letters => $letters );
52 C4::Service->return_success( $response );
55 C4::Service->dispatch(
56 [ 'GET /', [ 'code' ], \&get_letters ],