Method: /file/create

From Videntity Wiki - The API Documentation

Jump to: navigation, search

URL: https://vidapi.com/file/create

Definition: Creates a file

Request Type: POST

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

Arguments: 2 (required), 3 (optional)

session_key (required): key to your current session. Your session key is given to you in response to your login request.
account_number (required): account number of file creator
file_access (optional): file access privileges (public, private)
filename (optional): uploaded audio file path/name


Response Type: XML

Response Format: 

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


Errors:

ERROR NUMBER ERROR NAME ERROR DETAILS ERROR EXPLANATION
2 SESSION_DOES_NOT_EXIST 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 The 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 account_number is missing Every method has a set number of required fields that must be included in a method call. If the required method arguments are missing this error is returned.
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="/file/create">
    <status>ERROR</status>
    <api_tx_number>134</api_tx_number>     
    <error_number>3</error_number>
    <error_name>SESSION_EXPIRED</error_name>
    <error_detail>The session has expired</error_detail>  
    <timestamp>2008-09-30 15:56:42</timestamp>
</response>
Retrieved from "http://wiki.videntity.com/wiki/index.php/Method:_/file/create"
Personal tools