This is an old revision of the document!
/api/applications/ID/documents
HEAD, GET
Get a list of documents that have been attached to this application. The HEAD
verb is useful if you only want to test if this application has any documents attached at all (and how many). Use the GET
verb to get the listing of documents.
In order to retrieve the binary data of the document, you need to call /api/applications/ID/documents/ID. In the example below, you will need to call /api/applications/123/documents/222
to retrieve the first document as an image file.
Note that an applicant may have more documents but may only choose to attach some (more relevant, perhaps) of them to a particular application. Use the /api/applicants/ID/documents call to see all of the documents that have been uploaded by an applicant.
Syntax
GET /api/applications/123/documents Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234 X-Count: 15
Response example
{ "222": { "uploaded": "2014-04-29T15:46:38+00:00", "name": "Passport", "mime": "image/jpeg", "size": "1966954" }, "333": { "uploaded": "2014-04-29T15:46:38+00:00", "name": "Diploma", "mime": "image/jpeg", "size": "310178" } }