Export

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

Represents a single application export.

URI
/api/v9/applications/ID/exports/ID

Get an export

Fetch information about a specific application export identified by the export ID.

All exports are always made against a specific offer (as is evident from the response below). For example, if an applicant has received Accepted offers for two courses, there might be different exports for both of them.

The actual exported (binary) files are called blobs (Binary Large OBjects) and are listed and can be retrieved separately, using the URI given in the reply.

Syntax
GET /api/v9/applications/123/exports/1
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/exports/1"

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 export data was successfully returned
`404 Not Found`	The export was not found

Example response

Response
{
  "exported": "2014-05-19T13:10:08+00:00",
  "processed": "2014-05-19T13:10:33+00:00",
  "cancelled": null,
  "offer": "/api/v9/offers/60",
  "profile": {
    "code": "CONTRACT",
    "name": "Study contract",
    "adapter": {
      "adapter": "SpecialExportAdapterForABCUniversity",
      "fields": {
        "Contract type": "MSc",
        "Print signatures": "yes"
      }
    }
  },
  "blobs": {
    "/api/v9/applications/123/exports/1/blobs/1-537a02b27c20b": "StudyContract.pdf"
  }
}

Exports

Blobs