On pages 155-159 of the API manual, the description of the API response 
to Process Pending Order could use some work.

First of all, the docs explaining the format of the returned parameters 
don't mention the fact that there are two separate arrays or attributes 
returned, called "rwi_attributes" or "attributes":

$VAR1 = {
    'rwi_attributes' => {
        'order_id' => '11554082',
        'number_of_canceled_orders' => '0'
    },
    'is_success' => '1',
    'protocol' => 'XCP',
    'object' => 'DOMAIN',
    'attributes' => {
        'registration expiration date' => undef,
        'id' => '0',
        'f_auto_renew' => undef
    },
    'response_text' => 'Transfer request has been successfully sent...',
    'response_code' => '200',
    'action' => 'REPLY'
};

I'm not sure why there are two separate but similar arrays in the result, 
but anyway, the description for "order_id", for example, should probably 
mention that it's returned in "rwi_attributes", since that's nonstandard.

What's more confusing is that although the Perl response code example 
shows "rwi_attributes" correctly, the "Response Examples (XML)" section 
has the following incorrect example that mixes up the two:

<item_key="attributes>   [sic, no closing quotes]
  <dt_assoc>
    <item_key="order_id">3738554</item>
    <item_key="number_of_cancelled_orders">0</item>
  </dt_assoc>
</item>

That first line should read:

<item_key="rwi_attributes">

Finally, there is no description in the docs of the "id" value in 
"attributes". Perhaps it's the same as the deprecated "transaction_id"?

On a separate but related subject, the latest version of the API 
introduced the "Process Transfer" command to "allow the resubmission of 
failed transfers" from Declined Orders. I don't understand why that's 
needed, since "Process Pending" works just fine for doing that. Perhaps 
someone from OpenSRS can explain what is different about "Process 
Transfer" that should cause people to use it instead of "Process Pending 
Order"?

-- 
Robert L Mathews, Tiger Technologies      http://www.tigertech.net/

Reply via email to