Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| api:api_applications_id_documents [2014/06/26 19:27] – created Lauri | api:api_applications_id_documents [2025/06/09 13:48] (current) – Lauri | ||
|---|---|---|---|
| Line 5: | Line 5: | ||
| Get a list of documents that have been attached to this application. The '' | Get a list of documents that have been attached to this application. The '' | ||
| - | Note that an applicant may have more documents but may only choose | + | 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 ''/ |
| ==== Syntax ==== | ==== Syntax ==== | ||
| Line 24: | Line 24: | ||
| { | { | ||
| " | " | ||
| + | " | ||
| " | " | ||
| " | " | ||
| Line 30: | Line 31: | ||
| }, | }, | ||
| " | " | ||
| + | " | ||
| " | " | ||
| " | " | ||
| Line 36: | Line 38: | ||
| } | } | ||
| } | } | ||
| + | |||
| + | |||
| + | ===== POST ===== | ||
| + | |||
| + | Initiate an upload process to add a new document to the application. | ||
| + | |||
| + | Please note that there is also a call to upload a document to a specific task: [[api:/ | ||
| + | |||
| + | The process is as follows: | ||
| + | |||
| + | - Client calls '' | ||
| + | - API returns code 204 and an ingress URL on the '' | ||
| + | - Client pushes a file using a standard multipart request, for example like '' | ||
| + | - The ingress service returns code 201 if the file was accepted. | ||
| + | |||
| + | The ingress URL is valid for 30 minutes to upload the file (or files - the URL can be used multiple times to upload multiple files within the 30 minute window). Up to 10MiB are allowed, and any of the usual MIME-s are allowed (same as in the UI). **:!: The ingress URL should not be made public, but should be treated as secure material.** | ||
| + | |||
| + | ==== Syntax ==== | ||
| + | |||
| + | POST / | ||
| + | Host: apply.example.edu | ||
| + | Authorization: | ||
| + | |||
| + | ==== Response codes ==== | ||
| + | |||
| + | | '' | ||