Offer attachment
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single offer attachment.
Syntax
/api/v9/applications/ID/offers/ID/attachments/ID
Host: apply.example.edu
Authorization: DREAM apikey="..."GET Get an offer attachment
Fetch the metadata associated with an offer attachment. Currently this API request is only provided for the sake of completeness. It is likely easier to fetch the entire list using GET /api/v9/applications/ID/offers/ID/attachments and then download the needed resources using GET /api/v9/applications/ID/offers/ID/attachments/ID/download.
Syntax
GET /api/v9/applications/123/offers/321/attachments/1001
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/v9/applications/123/offers/321/attachments/1001"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | 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": 1001,
"download": "/api/v9/applications/123/offers/321/attachments/1001/download"
}