Offer attachment

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a single offer attachment.

Syntax
/api/v10/applications/ID/offers/ID/attachments/ID
Host: apply.example.edu
Authorization: DREAM apikey="..."

Get an offer attachment

Retrieve the metadata associated with an offer attachment.

If the attachment is generated from a letterhead, the API request also returns the letterhead URI.

This API request is provided only for the sake of completeness. Typically, to retrieve information about offer attachments, you will:

Retrieve the entire list of offer attachments using
GET /api/v10/applications/ID/offers/ID/attachments.
Download the needed resources using
GET /api/v10/applications/ID/offers/ID/attachments/ID/download.

Syntax
GET /api/v10/applications/123/offers/321/attachments/100
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applications/123/offers/321/attachments/100"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The attachment record was found
`404 Not Found`	This attachment does not belong to this offer

Example response

Response
{
  "id": 100,
  "letterhead": "/api/v10/letterheads/10",
  "download": "/api/v10/applications/123/offers/321/attachments/100/download"
}