This is an old revision of the document!
/api/applications/ID/offers/ID/letters
HEAD, GET
Get a list of all letters that have been generated from
Syntax
GET /api/applications/123/offers/321/letters Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234 X-Count: 1
Response example
TODO
POST
TODO
Syntax
POST /api/applications/123/offers/321/letters Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
| Name | Description | |
|---|---|---|
letterhead | Required | Letterhead ID to use as the template for generating this letter |
Response headers
Content-Type: application/json Content-Length: 0 Location: /api/applications/123/offers/321/letters/1001
Response codes
201 Created | New letter was created, rendered to PDF and attached to the offer |
400 Bad Request | The letterhead ID was not provided as a parameter |
404 Not Found | The letterhead was not found |
400 Bad Request | There is already a pre-existing letter generated from this letterhead |
400 Bad Request | Errors or warnings were encountered when filling the letterhead markers |