Table of Contents

/api/applications/ID/offers/ID/attachments/ID/download

GET, HEAD

Download a specific attachment.

There are two major ways that an attachment can be created:

  1. Uploading a file when composing the offer letter (this call returns the uploaded bytes verbatim)
  2. Generating a PDF attachment from a letterhead [1].

In addition:

  1. An attachment can be specified as part of an offer type, in which case it is attached automatically
  2. An attachment can be posted from the API

[1] Letterheads are document templates that can be used to generate attachments to offers. In reality, there is also a middle-step in that process — first a Letter is created from the Letterhead (and can be accessed using /api/applications/ID/offers/ID/letters). Such a Letter represents a generated (and potentially user-customised) document, where each template marker has already been replaced by actual applicant data. For the purposes of attaching to an offer, the Letter is converted to a PDF and attached o an offer just like a regular uploaded PDF. All of this happens seamlessly in the UI, however, for the API the entire data model is explicitly shown.

Syntax

GET /api/applications/123/offers/234/attachments/1001/download
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/octet-stream