Download a publication from OPDS

GET

/opds/v2/publications/{publicationId}/file

curl --request GET \
  --url http://localhost:8080/opds/v2/publications/1/file \
  --header 'Authorization: Bearer <token>'

The same as /api/v1/publications/{publicationId}/file, with an OPDS sign-in challenge on 401.

Authorizations

• session
• basic

Parameters

Path Parameters

publicationId

required

integer format: int64

Responses

200

The original file.

Media typeapplication/octet-stream

string format: binary

206

The requested byte range.

304

The client’s copy is current.

401

No valid credentials. The Basic challenge and the Authentication for OPDS document both ask for a name and password.

Media typeapplication/opds-authentication+json

An Authentication for OPDS document offering HTTP Basic sign-in.

object

id

required

string format: uri

title

required

string

authentication

required

Array<object>

object

type

required

string

labels

object

login

string

password

string

Example

{
  "authentication": [
    {
      "type": "http://opds-spec.org/auth/basic"
    }
  ]
}

Headers

WWW-Authenticate

string

Example

Basic realm="Chek", charset="UTF-8"

Link

string

Example

<https://chek.example/opds/v2/auth>; rel="http://opds-spec.org/auth/document"; type="application/opds-authentication+json"

404

The resource does not exist.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

409

The file changed on disk since it was scanned. A rescan has started; retry after it finishes.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

500

The server failed; details are in its log.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

502

The publication is from a source library, and its source couldn’t be read (source_unavailable) or its extension failed (source_failed); the message says why.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}