Get the document of the fax identified by given id and format
Resource URL
GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/{id}.{format}
Resource Information
-
Response Content-Type (two possible values, depending on "format"):
-
tiff: image/tiff
-
pdf: application/pdf
-
-
Requires authentication: Yes
URL Parameters
|
Name |
Type |
Required |
Description |
Default |
Example |
|---|---|---|---|---|---|
|
id |
string |
required |
The id of the fax which you want retrieve the document |
null |
IAS-N1_401d6c8c07d6b7a_0.pdf |
|
format |
string |
required |
The format of the file to download. Must be one of the following:
|
null |
|
Response
200 OK
Fax has been downloaded.
Error response
401 Unauthorized
-
No authentication provided
-
Wrong credentials
403 Forbidden
-
Insufficient privilege level
404 NotFound
-
No such inbound fax having the given id
410 Gone
-
The fax exists, but related document has been removed
Examples
GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/IAS-N1_401d6c8c07d6b7a_0.pdf