Back to API references

SOAP API method ProfileDir_file

Description

The parameter is the name of the file and it returns a ProfileFile object if the supplied filename exists in this dir or false if no such file was found

Parameters

Name Type Description
id * int Unique identifier (id) of the object ProfileDir. The method only applies to the profiledir with this id.
name * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
profilefile Structure of type 'profilefile'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'profilefile'

Name Type Description
author string The name of the person who uploaded the file.
created timestamp The timestamp when the file was uploaded for the first time.
modified timestamp The timestamp when the file was last modified.
id int The ID of the file.
mimetype string The mimetype of the file.
hashcode string Expose the file hashcode
data binary The data of the file. The data is base64 encoded.
name string The filename of the file.
size int The size of the file.