Download document

GET

packages

{packageId}

download

{documentId}

Error

A valid request URL is required to generate request examples

"<string>"

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

[
  {
    "ErrorCode": "Package.InvalidStatus:pending",
    "ErrorMessage": "Could not perform operation on package with id [c63e886c-1980-4d83-8d5b-03acdebc38dd] because status is [pending]"
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

packageId

string<guid>

required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

documentId

string<guid>

required

The target document's unique identifier A document's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

The specified document in a pdf or xml file

The response is of type file.

Get document by order indexRetrieves a single document from a package by its order index - the position that defines how documents are sorted within the package. The order index must be a positive integer.

Error

A valid request URL is required to generate request examples

"<string>"

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

[
  {
    "ErrorCode": "Package.InvalidStatus:pending",
    "ErrorMessage": "Could not perform operation on package with id [c63e886c-1980-4d83-8d5b-03acdebc38dd] because status is [pending]"
  }
]

Product updates

NSEV WebPortal API

Authorizations

Path Parameters

Response