Method: /transaction/read

From Videntity Documentaion Wiki

Revision as of 02:17, 5 October 2009 by Cboyce (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

URL: https://vidapi.com/transaction/read

Definition: reads a transaction

Request Type: POST

Content-Type: application/x-www-form-urlencoded

Arguments: 2 (required)

session_key (required): key to your current session. Your session key is given to you in response to your login request.
transaction_uuid (required): unique transaction ID

Response Type: XML

Response Format: 

   <?xml version="1.0" encoding="utf-8"?>
   <response api_method="transaction/read">
        <status>STATUS</status>
        <api_tx_number>TRANSACTION_NUMBER</api_tx_number>
        <detail>DETAILS</detail>
        <response_name_value>
            <tx_id>TRANSACTION_ID</tx_id>
        </response_name_value>
        <timestamp>TIMESTAMP</timestamp>
   </response>


Errors:

ERROR NUMBER ERROR NAME ERROR DETAILS ERROR EXPLANATION
2 SESSION_DOES_NOT_EXIST Your session does not exist This error message indicates that your session hasn't been created or has expired. If you receive this error message please call the API login URL to generate a new session.
3 SESSION_EXPIRED Your session has expired This error message indicates that your session hasn't been created or has expired. If you receive this error message please call the API login URL to generate a new session.
4 MISSING_MANDATORY_FIELD Mandatory field transaction_type is missing This error message indicates that the transaction_type field was not in your form POST arguments.
4 MISSING_MANDATORY_FIELD Mandatory field security_level is missing This error message indicates that the security_level field was not in your form POST arguments.
4 MISSING_MANDATORY_FIELD Mandatory field notification_message_id is missing This error message indicates that the notification_message_id field was not included in the form POST arguments. The notification_message_id is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field inquiry_message_id is missing This error message indicates that the inquiry_message_id field was not included in the form POST arguments. The inquiry_message_id is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field sender_id is missing This error message indicates that the sender_id field was not included in the form POST arguments. The sender_id is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field receiver_id is missing This error message indicates that the receiver_id field was not included in the form POST arguments. The receiver_id is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field sms_execute is missing This error message indicates that the phone_execute field was not included in the form POST arguments. The phone_execute is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field phone_execute is missing This error message indicates that the sms_execute field was not included in the form POST arguments. The sms_execute is a required field and must be in the arguments.
4 MISSING_MANDATORY_FIELD Mandatory field user_type is missing This error indicates that the user_type field was not included in the form POST arguments. The user_type is a required field and must be in the arguments.
7 ENUMERATION_ERROR Field response_type must be one of the following values: keypad or audio The value supplied in the field response_type is not in the enumerated list. Please make sure your response_type field is one of the following values: keypad or audio (lower case)
11 SERVER_ERROR The server could not process your request. The server could not process your request. Please Try again.


Error Example: 

<?xml version="1.0" encoding="utf-8"?>
<response api_method="transaction/read">
    <status>ERROR</status>
    <api_tx_number>1423534645</api_tx_number>     
    <error_number>36</error_number>
    <error_name>Post Error</error_name>
    <error_detail>user_type not in post</error_detail>  
    <timestamp>2008-09-30 15:56:42</timestamp>
</response>
Retrieved from "http://vidapi.com/wiki/index.php/Method:_/transaction/read"