= Remote access to output files =

== Web service interface ==

Output files can be downloaded using web services of several forms:
{{{
PROJECT_URL/get_output.php?cmd=result_file&auth_str=AUTH&result_name=NAME&file_num=N
PROJECT_URL/get_output.php?cmd=batch_files&auth_str=AUTH&batch_id=N
PROJECT_URL/get_output.php?cmd=workunit_file&auth_str=AUTH&wu_name=NAME&file_num=N
PROJECT_URL/get_output.php?cmd=workunit_files&auth_str=AUTH&wu_id=N
}}}

The variants are:

 * '''result_file''': download the Nth output file of the given result.
 * '''batch_file''': download all the output files of the given batch, as a zip archive.
 * '''workunit_file''': download the Nth output file of the canonical instance of the given workunit.
 * '''workunit_files''': download all the output files of the canonical instance of the given workunit,
  as a zip archive.

In each case, '''auth_str''' is the authenticator of the requesting user,
who must be the creator of the jobs involved.

Notes:

 * These operations work only for jobs that are part of a batch.
 * In case of error, the resulting file will have the work "error" in the first line.

== C++ interface ==

{{{
extern int get_output_file(
    const char* project_url,
    const char* authenticator,
    const char* job_name,
    int file_num,
    const char* dst_path
);
}}}

== PHP interface ==
=== boinc_get_output_file() ===

Get a URL for a particular output file.

Argument: a request object with elements
 * '''project''' and '''authenticator''': as above,
 * '''instance_name''': specifies a job instance,
 * '''file_num''': the ordinal number of one of the output files.

Result: a URL from which the output file can be downloaded.

=== boinc_get_output_files() ===

Argument: a request object with elements
 * '''project''' and '''authenticator''': as above,
 * '''batch_id''': specifies a batch.

Result: a URL from which a zipped archive of all
output files from the batch can be downloaded
(only the outputs of "canonical" instances are included).