Exports

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

Represents a list of exports that have been generated from the application.

URI
/api/v9/applications/ID/exports

List exports

List all exports that have been generated from the application in question. Use the HEAD verb to see if there are any exports at all. The X-Count header will indicate the number of exports available.

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
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"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`15`	Number of exports for this application

Response codes

Response code	Description
`200 OK`	The list of exports was successfully returned

Example response

Response
{
  "1": {
    "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"
    }
  }, 
  "6": { ... }
  "7": { ... }
}

Tasks

Export