NAME

WebService::Recruit::Dokoiku::GetStation - Dokoiku Web Service Beta "getStation" API

SYNOPSIS

use WebService::Recruit::Dokoiku;

my $doko = WebService::Recruit::Dokoiku->new();
$doko->key( 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' );

my $param = {
    lon_jgd     =>  139.758,
    lat_jgd     =>   35.666,
};
my $res = $doko->getStation( %$param );
die 'error!' if $res->is_error;

my $list = $res->root->landmark;
foreach my $landmark ( @$list ) {
    print "code: ", $landmark->code, "\n";
    print "name: ", $landmark->name, "\n";
    print "web:  ", $landmark->dokopcurl, "\n";
    print "map:  ", $landmark->dokomapurl, "\n";
    print "\n";
}

my $root = $res->root;

DESCRIPTION

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

my $param = {
    pagenum     =>  '1',
    pagesize    =>  '10',
    name        =>  'name of station',
    code        =>  '4254',
    lat_jgd     =>  '35.6686',
    lon_jgd     =>  '139.7593',
    radius      =>  '1000',
    iarea       =>  '05800',
};
my $res = $doko->getStation( %$param );

$doko above is an instance of WebService::Recruit::Dokoiku.

METHODS

root

This returns the root element of the response.

my $root = $res->root;

You can retrieve each element by the following accessors.

$root->status
$root->totalcount
$root->pagenum
$root->landmark->[0]->code
$root->landmark->[0]->name
$root->landmark->[0]->dokopcurl
$root->landmark->[0]->dokomburl
$root->landmark->[0]->dokomapurl
$root->landmark->[0]->lat_jgd
$root->landmark->[0]->lon_jgd
$root->landmark->[0]->lat_tky
$root->landmark->[0]->lon_tky

xml

This returns the raw response context itself.

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

code

This returns the response status code.

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

is_error

This returns true value when the response has an error.

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

page

This returns a Data::Page instance.

my $page = $res->page();
print "Total: ", $page->total_entries, "\n";
print "Page: ", $page->current_page, "\n";
print "Last: ", $page->last_page, "\n";

pageset

This returns a Data::Pageset instance.

my $pageset = $res->pageset( 'fixed' );
$pageset->pages_per_set($pages_per_set);
my $set = $pageset->pages_in_set();
foreach my $num ( @$set ) {
    print "$num ";
}

page_param

This returns a hash to specify the page for the next request.

my %hash = $res->page_param( $page->next_page );

page_query

This returns a query string to specify the page for the next request.

my $query = $res->page_query( $page->prev_page );

SEE ALSO

WebService::Recruit::Dokoiku

AUTHOR

Yusuke Kawasaki http://www.kawa.net/

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

COPYRIGHT AND LICENSE

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

cpanm WebService::Recruit::Dokoiku

perl -MCPAN -e shell
install WebService::Recruit::Dokoiku