NAME

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

SYNOPSIS

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

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

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

DESCRIPTION

VARIABLES

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

new()

 # construct a new API request
 $request = iThenticate::API::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

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

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

SEE ALSO

 iThenticate::API::Client, iThenticate::API::Response, RPC::XML

AUTHOR

Fred Moyer <fred@iparadigms.com>

COPYRIGHT

Copyright 2008 iParadigms LLC