iThenticate::API::RequeUsste(r3)Contributed Perl DocumenitTahteinotnicate::API::Request(3)



NNAAMMEE
       iThenticate::API::Request - create request objects for the iThenti-
       cate::API

SSYYNNOOPPSSIISS
        # 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;

DDEESSCCRRIIPPTTIIOONN
VVAARRIIAABBLLEESS
       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.

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

       _v_a_l_i_d_a_t_e_(_)
            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 appro-
           priate error string;

FFAAQQ
       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.

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

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

AAUUTTHHOORR
       Fred Moyer <fred@iparadigms.com>

CCOOPPYYRRIIGGHHTT
       Copyright 2008 iParadigms LLC



perl v5.8.8                       2008-08-28      iThenticate::API::Request(3)