| WebService-30Boxes-API documentation | Contained in the WebService-30Boxes-API distribution. |
WebService::30Boxes::API::Response - Response from 30Boxes REST API
use WebService::30Boxes::API;
# You always have to provide your api_key
my $boxes = WebService::30Boxes::API->(api_key => 'your_api_key');
# Then you might want to lookup a user and print some info
my $result = $boxes->call('user.FindById', { id => 47 });
if($result->{'success'}) {
my $user = $result->reply->{'user'};
print $user->{'firstName'}, " ",
$user->{'lastName'}, " joined 30Boxes at ",
$user->{'createDate'},"\n";
} else {
print "An error occured ($result->{'error_code'}: ".
"$result->{'error_msg'})";
}
WebService::30Boxes::API::Response- Response from 30Boxes API
The response object is basically a HTTP::Request class, with a few things added. These keys can be queried:
Was the call succesful?
If not succesful, what error code did we get?
And the error message
reply returns the result of XML::Simple's parsing of the 30Boxes
reply. See the example above.
Please report any bugs to http://rt.cpan.org/Ticket/Create.html?Queue=WebService::30Boxes::API
M. Blom, <blom@cpan.org>, http://menno.b10m.net/perl/
Copyright (C) 2006 by M. Blom
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.
| WebService-30Boxes-API documentation | Contained in the WebService-30Boxes-API distribution. |
package WebService::30Boxes::API::Response; use strict; use warnings; use HTTP::Response; our @ISA = qw(HTTP::Response); our $VERSION = '1.05'; sub new { my ($class, $args) = @_; my $self = new HTTP::Response; $self->{'error_code'} = undef; $self->{'error_msg'} = undef; $self->{'success'} = undef; $self->{'_xml'} = undef; bless $self, $class; return $self; } sub set_error { my ($self, $code, $msg) = @_; $self->{'success'} = 0; $self->{'error_code'} = $code; $self->{'error_msg'} = $msg; } sub set_success { my ($self) = @_; $self->{'success'} = 1; $self->{'error_code'} = undef; $self->{'error_msg'} = undef; } sub reply { my ($self, $xml) = @_; $self->{'_xml'} = $xml if($xml); return $self->{'_xml'}; } 1; #################### main pod documentation begin ###################