Get status
Get the current status of a specific document upload.
Arguments
Name (bold if mandatory) | Type | Comments | Default |
---|---|---|---|
id | String | The ID of the upload to be queried. | None, mandatory. |
Response
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 upload. |
uploaded | Number | The number of bytes actually uploaded. |
uri | String | Fully-qualified resource URI of the upload. |
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/89a48657279d45429c646029bd9227e6 HTTP/1.
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
curl "https://rest.interfax.net/outbound/documents/89a48657279d45429c646029bd9227e6" ^
-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",
"disposition":"SingleUse",
"sharing":"Private"
}