Versions Compared

Old Version 2

changes.mady.by.user Gabriel BERLICKI

Saved on

compared with

New Version Current

changes.mady.by.user Gabriel BERLICKI

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When calling GET /retrievals to check the status of a retrieval request, OSFs can now pass an optional parameter:

expand
Section
Column

originalDocumentIndicator = true

Column

Image Modified


The response behaviour depends on this parameter and the type of document registered by the OFF.

...

Section
Column

When originalDocumentIndicator = true

OFF Document TypeResponse BodyResponse Header
Legacy PDFMerged PDF URLOriginal document URL (without cover page)
PDDP documentMerged PDF URLOriginal PDDP document URL


When originalDocumentIndicator = false or not provided

OFF Document TypeResponse BodyResponse Header
Legacy PDFMerged PDF URL(none)
PDDP with core PDF onlyMerged PDF URL(none)
PDDP with additional filesMerged PDF URLOriginal PDDP document URL
Column



...

Summary

  • If you need access to the original deposited document, pass originalDocumentIndicator = true in your request.
  • If the parameter is omitted or set to false, you will still receive the original PDDP URL in the header only if the OFF registered a PDDP with additional files.
  • In all cases, the merged PDF URL is always returned in the response body.

...