Method: Static Upload Enroll Message

From Videntity Documentaion Wiki

Jump to: navigation, search

URL: https://vidapi.com/static/upload_enroll_message

Definition: Used to set your enrollment message. Your enrollment message is played to every user you create before they enroll.

Request Type: POST

Content-Type: multipart/form-data

Arguments: 3 (required)

session_key (required): key to your current session. Your session key is given to you in response to your login request.
enroll_text (required): enrollment text file played to users before going through enrollment
enroll_audio (required): enrollment audio file played to users before going through enrollment

Response Type: XML

Response Format: 

   <?xml version="1.0" encoding="utf-8"?>
   <response api_method="static/upload_enroll_message">
        <status>STATUS</status>
        <api_tx_number>TRANSACTION_NUMBER</api_tx_number>
        <detail>DETAILS</detail>
        <response_name_value>
            <file>FILE_NAME</file> 
        </response_name_value>
        <timestamp>TIMESTAMP</timestamp>
   </response>

Response Example: 

   <?xml version="1.0" encoding="utf-8"?>
   <response api_method="static/upload_enroll_message">
        <status>SUCCESS</status>
        <api_tx_number>182737893</api_tx_number>
        <detail>your file uploaded successfully</detail>
        <response_name_value>
            <file>file_name</file> 
        </response_name_value>
        <timestamp>2008-09-30 15:56:42</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.
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="/session/ping">
    <status>ERROR</status>
    <api_tx_number>12123</api_tx_number>     
    <error_number>3</error_number>
    <error_name>Session Expired</error_name>
    <error_detail>session does not exist</error_detail>  
    <timestamp>2008-09-30 15:56:42</timestamp>
</response>
Retrieved from "http://vidapi.com/wiki/index.php/Method:_Static_Upload_Enroll_Message"
Personal tools