2114: Download terms version file

Owned by Nick Jensen
Nov 20, 2017
1 min read

Fetch a specific terms version file as an HTTP download.

This endpoint works best through a browser, which means it cannot be used directly with the standard Rubiq API authentication.

Consider enabling Public authentication for this endpoint, to allow open access to file downloads.


Endpoint ID:2114
Method:

GET

URL:

/permissions/terms/{termsID}/{version}/file/{fileKey}/download


termsIDA GUID string identifier for the terms

version

A terms version string formatted as "major.minor", i.e. "1.0" or "4.7".

Alternatively, the string "active" indicates the active version of these terms. This will result in an error if the terms have no active version defined.


fileKeyThe "key" of the specific file to fetch for this version.
Alternatively, the string "default" indicates the default file for this version.

Request body:

None

Response body:

An HTTP binary response, ready for a browser to handle as a file download. The following headers are included:

Content-Disposition

An "attachment" Content-Disposition descriptor containing the file name, eg.

attachment; filename=fine-print.pdf
Content-TypeThe file content type or mimeType, e.g. "application/pdf", "video/avi", "image/png"
Content-LengthThe file size in bytes
Status codes:200OK

400

Invalid request.

The following subcodes may be returned:

400.1These terms have no active version

404

The entity or terms were not found.

The following subcodes may be returned:

404.4Terms not found
404.7Terms version not found