Method: /session/login

From Videntity Documentaion Wiki

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

URL: https://vidapi.com/session/login

Definition: Logs in an API user and creates an API session.

Request Type: POST

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

Arguments: 3 (required)

username (required): username generated by use from your email account. Your username will be given to you during the enrollment process.
password (required): password given to you that is generated by the videntity server. Your password will be given to you during the enrollment process.
account_number (required):account number given to you by the videntity server. Your account number will be given to you during the enrollment process.

URL Encoded example: 

username=cboyce&password=Ry5NvPAbceAS123&account_number=210983749212839

Response Type: XML

Response Format: 

   <?xml version="1.0" encoding="utf-8"?>
   <response api_method="/session/login">
        <status>STATUS</status>
        <api_tx_number>TRANSACTION_NUMBER</api_tx_number>
        <detail>DETAILS</detail>
        <response_name_value>
            <session_key>De325h3Fsdg76rt</session_key>
        </response_name_value>
        <timestamp>TIMESTAMP</timestamp>
   </response>

Response Example: 

   <?xml version="1.0" encoding="utf-8"?>
   <response api_method="/session/login">
        <status>SUCCESS</status>
        <api_tx_number>182737893</api_tx_number>
        <detail>you logged in successfully</detail>
        <response_name_value>
            <session_key>De325h3Fsdg76rt</session_key>
        </response_name_value>
        <timestamp>2008-09-30 15:56:42</timestamp>
   </response>

Errors:

ERROR NUMBER ERROR NAME ERROR DETAILS ERROR EXPLANATION
1 AUTHENTICATION_ERROR username, password or account_number is incorrect This error message indicates that your username, password, or account number is incorrect. For security reasons we don't tell you which one, so check all three if you get this error.
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="/user/login">
    <status>ERROR</status>
    <api_tx_number>12</api_tx_number>     
    <error_number>1</error_number>
    <error_name>Authentication Error</error_name>
    <error_detail>username, password or account_number is incorrect</error_detail>  
    <timestamp>2008-09-30 15:56:42</timestamp>
</response>
Retrieved from "http://vidapi.com/wiki/index.php/Method:_/session/login"