WebService::iThenticate::Request - create request objects for the WebService::iThenticate


WebService-iThenticate documentation  | view source Contained in the WebService-iThenticate distribution.

Index


NAME

Top

WebService::iThenticate::Request - create request objects for the WebService::iThenticate

SYNOPSIS

Top

 # construct a new API request
 $request = WebService::iThenticate::Request->new( {
     method => 'login',         # required
     auth   => $auth_object,    # auth object appropriate to the transport mechanism
 } );

 # make the request using an WebService::iThenticate::Client user agent
 $response = $client->make_request( { request => $request } );

 # dump out the request as a string
 $string = $request->as_string;




DESCRIPTION

Top

VARIABLES

Top

Validations

This package scoped hash consists of methods and their required arguments. It is necessary because we cannot always rely on the server to validate request arguments.

METHODS

Top

new()
 # construct a new API request
 $request = WebService::iThenticate::Request->new({
     method => 'login',               # required
     auth   => $auth_object,          # required
 });

validate()
 my $validated_args = eval { $class->validate( $method, $args->{req_args} ) };

Given an xmlrpc method, and a hash reference of key value argument pairs, this returns the corresponding RPC::XML entities. If any arguments are missing or invalid, this method dies with an appropriate error string;

FAQ

Top

Q: Why are you using this hodge podge validation scheme instead of Params::Validate?

A: To minimize the number of dependencies. Partly evil yes, but easy install is one of the goals of this module.

BUGS

Top

Plenty at this stage I'm sure. Send patches to the author.

SEE ALSO

Top

 WebService::iThenticate::Client, WebService::iThenticate::Response, RPC::XML

AUTHOR

Top

Fred Moyer <fred@iparadigms.com>

COPYRIGHT

Top


WebService-iThenticate documentation  | view source Contained in the WebService-iThenticate distribution.