Locale::ID::Locality
version 0.04
use Locale::ID::Locality qw(list_id_localities); my $res = list_id_localities(detail=>1);
This module provides API access for list of localities (cities/regencies) in Indonesia. Data is currently retrieved from the gudang-data-interim repository at https://github.com/sharyanto/gudang-data-interim/tree/master/data/ind_locality/
This module's functions have Rinci specs.
None are exported by default, but they are exportable.
list-id-localities
Gudang Data Interim project, https://github.com/sharyanto/gudang-data-interim/
This API will also be available on GudangAPI, http://gudangapi.com/
This module has Rinci metadata.
Localities (cities & regencies) in Indonesia.
REPLACE ME
Arguments ('*' denotes required arguments):
bps_code* => int
Only return records where the 'bps_code' field equals specified value.
bps_code.is* => int
bps_code.max => int
Only return records where the 'bps_code' field is less than or equal to specified value.
bps_code.min => array
Only return records where the 'bps_code' field is greater than or equal to specified value.
bps_code.xmax => int
Only return records where the 'bps_code' field is less than specified value.
bps_code.xmin => array
Only return records where the 'bps_code' field is greater than specified value.
bps_prov_code* => int
Only return records where the 'bps_prov_code' field equals specified value.
bps_prov_code.is* => int
bps_prov_code.max => int
Only return records where the 'bps_prov_code' field is less than or equal to specified value.
bps_prov_code.min => array
Only return records where the 'bps_prov_code' field is greater than or equal to specified value.
bps_prov_code.xmax => int
Only return records where the 'bps_prov_code' field is less than specified value.
bps_prov_code.xmin => array
Only return records where the 'bps_prov_code' field is greater than specified value.
detail => bool (default: 0)
Return array of full records instead of just ID fields.
By default, only the key (ID) field is returned per result entry.
fields* => array (default: "ind_name")
Select fields to return.
ind_name* => str
Only return records where the 'ind_name' field equals specified value.
ind_name.contains => str
Only return records where the 'ind_name' field contains specified text.
ind_name.is* => str
ind_name.max => str
Only return records where the 'ind_name' field is less than or equal to specified value.
ind_name.min => array
Only return records where the 'ind_name' field is greater than or equal to specified value.
ind_name.not_contains => str
Only return records where the 'ind_name' field does not contain a certain text.
ind_name.xmax => str
Only return records where the 'ind_name' field is less than specified value.
ind_name.xmin => array
Only return records where the 'ind_name' field is greater than specified value.
q => str
Search.
random => bool (default: 0)
Return records in random order.
result_limit => int
Only return a certain number of records.
result_start => int (default: 1)
Only return starting from the n'th record.
sort => str
Order records according to certain field(s).
A list of field names separated by comma. Each field can be prefixed with '-' to specify descending order instead of the default ascending.
type* => int
Only return records where the 'type' field equals specified value.
type.is* => int
type.max => int
Only return records where the 'type' field is less than or equal to specified value.
type.min => array
Only return records where the 'type' field is greater than or equal to specified value.
type.xmax => int
Only return records where the 'type' field is less than specified value.
type.xmin => array
Only return records where the 'type' field is greater than specified value.
with_field_names => bool
Return field names in each record (as hash/associative array).
When enabled, function will return each record as hash/associative array (field name => value pairs). Otherwise, function will return each record as list/array (field value, field value, ...).
Return value:
Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Steven Haryanto <stevenharyanto@gmail.com>
This software is copyright (c) 2012 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Locale::ID::Locality, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Locale::ID::Locality
CPAN shell
perl -MCPAN -e shell install Locale::ID::Locality
For more information on module installation, please visit the detailed CPAN module installation guide.