File Coverage

blib/lib/WebService/Recruit/HotPepper/ServiceArea.pm

Criterion	Covered	Total	%
statement	12	16	75.0
branch			n/a
condition			n/a
subroutine	6	10	60.0
pod	5	7	71.4
total	23	33	69.7

package WebService::Recruit::HotPepper::ServiceArea;
use strict;
use base qw( WebService::Recruit::HotPepper::Base );
use vars qw( $VERSION );
$VERSION = '0.02';

sub url { 'http://api.hotpepper.jp/ServiceArea/V110'; }
sub force_array { [qw( ServiceArea Error )]; }
sub elem_class  { 'WebService::Recruit::HotPepper::ServiceArea::Element'; }
sub query_class { 'WebService::Recruit::HotPepper::ServiceArea::Query'; }

sub query_fields { [qw(
    key
)]; }
sub root_elem { 'Results'; }
sub elem_fields { {
    Results => [qw(
        NumberOfResults APIVersion
        ServiceArea
    )],
    ServiceArea => [qw(
        ServiceAreaCD ServiceAreaName LargeServiceAreaCD
    )],
}; }

# __PACKAGE__->mk_query_accessors();

@WebService::Recruit::HotPepper::ServiceArea::Query::ISA = qw( Class::Accessor::Fast );
WebService::Recruit::HotPepper::ServiceArea::Query->mk_accessors( @{query_fields()} );

# __PACKAGE__->mk_elem_accessors();

@WebService::Recruit::HotPepper::ServiceArea::Element::ISA = qw( Class::Accessor::Children::Fast );
WebService::Recruit::HotPepper::ServiceArea::Element->mk_ro_accessors( root_elem() );
WebService::Recruit::HotPepper::ServiceArea::Element->mk_child_ro_accessors( %{elem_fields()} );

=head1 NAME

WebService::Recruit::HotPepper::ServiceArea - HotPepper Web Service "ServiceArea" API

=head1 SYNOPSIS

    use WebService::Recruit::HotPepper;

    my $api = WebService::Recruit::HotPepper->new();
    $api->key( 'xxxxxxxxxxxxxxxx' );

    my $res = $api->ServiceArea();
    die 'error!' if $res->is_error;

    my $list = $res->root->ServiceArea;
    foreach my $area ( @$list ) {
        print "name:  ", $area->ServiceAreaName, "\n";
        print "code:  ", $area->ServiceAreaCD, "\n";
        print "\n";
    }

=head1 DESCRIPTION

This module is an interface for the C API.
It accepts following query parameters to make an request.

    my $res = $hpp->ServiceArea();

C<$hpp> above is an instance of L.

=head1 METHODS

=head2 root

This returns the root element of the response.

    my $root = $res->root;

You can retrieve each element by the following accessors.

    $root->NumberOfResults;
    $root->APIVersion;
    $root->ServiceArea->[0]->ServiceAreaName;
    $root->ServiceArea->[0]->ServiceAreaCD;
    $root->ServiceArea->[0]->LargeServiceAreaCD;

=head2 xml

This returns the raw response context itself.

    print $res->xml, "\n";

=head2 code

This returns the response status code.

    my $code = $res->code; # usually "200" when succeeded

=head2 is_error

This returns true value when the response has an error.

    die 'error!' if $res->is_error;

=head1 SEE ALSO

L

=head1 AUTHOR

Toshimasa Ishibashi L

This module is unofficial and released by the author in person.

=head1 THANKS TO

Yusuke Kawasaki L

For creating/preparing all the base modules and stuff.

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2007 Toshimasa Ishibashi. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

=cut

1;