Get list
Get a list of previous document uploads which are currently available.
Arguments
Name (bold if mandatory) | Type | Comments | Default |
---|---|---|---|
limit | Number | How many document references to return. | 25 |
offset | Number | Skip this many document references in the list. | 0 |
Response
If successful, a structure listing previous documents is returned, containing the following properties:
Property | Type | Description |
---|---|---|
userId | String | Username under which document was created. |
fileName | String | The filename provided when the document was uploaded, e.g. newsletter.pdf |
fileSize | Number | The planned size in bytes of the document. |
uploaded | Number | The number of bytes actually uploaded. |
uri | String | Fully-qualified resource URI of the document. |
creationTime | DateTime | |
lastUsageTime | DateTime | |
status | String | Created , PartiallyUploaded , Uploading , Ready , Deleting |
disposition | String | SingleUse , MultiUse , Permanent |
sharing | String | Private , Shared |
Sample Call
Raw HTTP
GET /outbound/documents HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
Get a list of previous document uploads. Limit to 3 results and skip 5 documents each time.
curl "https://rest.interfax.net/outbound/documents?limit=3&offset=5" ^
-u username:password
Sample response (prettified for display here)
{
"userId":"myuserid",
"fileName":"sampledoc.pdf",
"fileSize":82318,"
uploaded":0,
"uri":"https://rest.interfax.net/outbound/documents/89a48657279d45429c646029bd9227e6",
"creationTime":"2012-06-23T17:49:25",
"lastusageTime":"2012-06-23T17:49:25",
"status":"Created"
....
}