Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
api:api_applications_id_documents [2014/06/26 19:27] – created Lauri Elevantapi:api_applications_id_documents [2021/01/21 12:51] (current) – external edit 127.0.0.1
Line 5: Line 5:
 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. 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.
  
-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:api_applicants_123_documents|/api/applicants/123/documents]] call to see all of the documents that have been uploaded by an applicant.+In order to retrieve the binary data of the document, you need to call [[api:api_applications_ID_documents_ID|/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:api_applicants_ID_documents|/api/applicants/ID/documents]] call to see all of the documents that have been uploaded by an applicant.
  
 ==== Syntax ==== ==== Syntax ====