| Route |
/api/Convert |
| Action |
POST |
| Description |
Convert a word document to PDF. Send file as response. |
| Body Parameters |
| Name |
Type |
Required |
Description |
| File |
file |
Required |
The file to be converted |
| DocumentId |
string |
Required |
A DocumentID or identifiyer |
| OutputType |
string |
Optional |
Either "Key" for key response, or default Download |
| PDFType |
string |
Optional |
Either "EPO" for Amyuni, or default PDF-A |
| ExcludeDocumentId |
string |
Optioal |
Exclude DocumentID at start of filename, "true" or default "false" |
|
| Response |
| Response |
Type |
Format |
Description |
| HttpResponseMessage OK (200) |
File |
D__{DocumentId}__{OriginalFilename} |
File (.pdf) as "application/octet-stream" |
| HttpResponseMessage BadRequest (400) |
string |
{message} |
Message contains reason for bad request |
|
| Route |
/api/GetByKey |
| Action |
POST |
| Description |
Get a converted document with a key, if exists and ready. Send file as response. |
| URI Parameters |
none |
| Body Parameters |
| Name |
Type |
Required |
Description |
| Key |
string |
Required |
The key to find the file |
|
| Response |
| Response |
Type |
Format |
Description |
| HttpResponseMessage OK (200) |
File |
D__{DocumentId}__{OriginalFilename} |
File (.pdf) as "application/octet-stream" |
| HttpResponseMessage BadRequest (400) |
string |
{message} |
Message contains reason for bad request |
|