ipOne API Documentation


document/file_list

Important:  An API Key is required to work with these API Calls

Returns the list of files inside a given document group. The user must have access to the given folder because otherwise the list would be returned empty.

Sample Request

http://api.verifiapp.com/document/file_list/{API-KEY}/{folder_id}

Sample Response

{"result":"success","results":[{"folder_id":"2","folder_name":"ipONE HSEQ","file_id":"2","file_token":"22afe29415f98fb07eb920c658af9b6e","file_name":"Letter of Offer","file_size":"25047","file_created_date":"2012-08-23 16:46:03","file_modified_date":"2012-08-23 16:46:03","created_by_full_name":"Teodora Boanchis","modified_by_full_name":"Teodora Boanchis","link":"http:\/\/verifiapp.com\/index.php\/my_documents\/file_secret_url\/22afe29415f98fb07eb920c658af9b6e.pdf","file_filename":"fm-26_letter_of_offer_template.pdf"}]}

Successful response reference

A successful response will return the following items in a JSON array

Preference Description
result success
results An array containing the following information:
  folder_id The unique folder ID
  folder_name The folder name
  file_id The unique file ID
  file_token Value to build the URLs to the file
  file_name The custom name given to the file
  file_size The size of the file in bytes
  file_created_date The date when the file was created
  file_modified_date The date when the file was modified by the last time
  created_by_full_name The full name of the person who uploaded the file
  modified_by_full_name The full name of the person who modified the file by the last time
  link The link to directly download the file.
  file_filename The name of the file in the Storage System. Useful to give it the proper name when downloading the file in Android.