SOAP API method Export_start

Back to API references

Description
If - for whatever reason - the export cannot be started, false is returned. Otherwise true is returned. The export cannot be started it it is already running, or if the output is in .xls or .txt format (see extension) and fields from more than one collection are linked to the export.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Export. The method only applies to the export with this id.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'value' : boolean

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt