Back to API references

SOAP API method MediaLibrary_file

Description

Get access to a single file from the media library

Parameters

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

Return values

Name Type Description
medialibraryfile Structure of type 'medialibraryfile'

Structure 'medialibraryfile'

Name Type Description
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.

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 'medialibraryfile'

Name Type Description
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.