Get Workflow History
https://api.signinghub.com/v3/packages/{package_id}/log |
||
HTTP Verb |
GET |
|
Accept |
application/json |
|
Authorization |
Bearer {access_token} |
|
Request Body |
|
|
Status Code |
Message |
Response Body |
200 |
OK
|
{
"package_id" : 123, "package_status" : "COMPLETED" , "package_owner" : "john@ascertia.com" , "owner_name" : "John Smith" , "next_signer" : "Sam Crook" , "next_signer_email" : [ { "user_email" : "sam@ascertia.com" , "user_name" : "Sam Crook" } ], "documents" : [ { "document_id" : 123, "document_name" : "sales contract 105" , "document_order" : 1, "document_type" : "PDF" , "document_source" : "My App" , "document_width" : 600, "document_height" : 800, "document_pages" : 12, "uploaded_on" : "2015-01-12T11:12:13" , "modified_on" : "2015-01-13T10:10:15" , "form_fields" : true , "lock_form_fields" : true , "certify" : { "enabled" : true , "permission" : "FORM_FILLING_ALLOWED" }, "template" : { "template_name" : "Sales Contract Template" , "read_only" : true } } ], "actions" : [ { "log_id" : 1, "date_time" : "2015-01-12T11:12:13" , "action_type" : "SHARED" , "user_email" : "john@ascertia.com" , "user_name" : "John Smith" , "enterprise_name" : "TEFCO INC." , "information" : { "type" : "SHARED_WITH" , "value" : "Mark Spencer" } }, { "log_id" : 1, "date_time" : "2015-01-12T11:14:13" , "action_type" : "OPENED" , "user_email" : "john@ascertia.com" , "user_name" : "John Smith" , "enterprise_name" : "TEFCO INC." , "information" : { "type" : "VIEWER" , "value" : "WEB_BROWSER" } }, { "log_id" : 1, "date_time" : "2015-01-12T11:19:13" , "action_type" : "SIGNED" , "user_email" : "john@ascertia.com" , "user_name" : "John Smith" , "enterprise_name" : "TEFCO INC." , "information" : { "type" : "METHOD" , "value" : "SERVER" } } ] } |
401 |
Unauthorized |
{ "Message" : "Request authorization denied" } |
{ "Message" : "User authentication required" } |
||
403 |
Forbidden |
{ "Message" : "Document does not belong to user" } |
{ "Message" : "Account is disabled" } |
||
{ "Message" : "You are not allowed to perform the requested operation" } |
||
404 |
Not Found |
{ "Message" : "Document not found" } |
500 |
Internal Server Error |
{ "Message" : "An internal server error occurred while processing the request" } |
Item Details | |
Names |
Description |
Request Parameters |
|
access_token | The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges. |
document_id |
The ID of the document for which log is required. |
Response Parameters | |
package_id | ID of the package for which the workflow history is requested. |
package_status | Status of the package/document with the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED". |
package_owner |
Email address of the package owner. |
owner_name |
Name of the package owner. |
next_signer |
Name of the next recipient. |
next_signer_email | Object having name and email address of the next recipient. |
documents > document_id |
ID of the document. |
documents > document_order |
Order of the document in the document package. |
documents > document_type | Extension of the document before uploaded and conversion to the PDF. |
documents > document_source | Source of the document from where the document was uploaded. |
documents > document_width |
Width of the PDF document in pixels. |
documents > document_height |
Height of the PDF document in pixels. |
documents > document_pages |
Total number of pages in the document. |
documents > uploaded_on | Date and time on which the document was uploaded to the package. |
documents > modified_on | Date and time on which the document was last modified. |
documents > form_fields | True, if form fields exist in the document. |
documents > lock_form_fields | True, if document form fields are to be locked after the last digital signatures on the document. |
documents > certify > enabled | True, if certify signature setting is enabled for the document. |
documents > certify > permission |
Certify permission level that is set for the certify signature settings on the document. The possible values are "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" and "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".
|
documents > template > template_name |
Name of the template applied on the document. |
documents > template > read_only |
True, if template applied on the document is read only. |
actions > log_id | ID of an action performed on the document. |
actions > date_time | Date and time when the action was performed. |
actions > user_email | Email of the user who performed the action. |
actions > user_name | Name of the user who performed the action. |
actions > enterprise_name | The name of Enterprise to which the user belongs. If the user doesn't belong to an enterprise, then this element is not present. |
actions > information > type | The type of extra information about the action e.g. "SIGNING_METHOD" which means what signing method user used to sign the document. |
actions > information > value | The value of the extra information about the action e.g. "LOCAL" which means user signed the document using locally held credentials. |
Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |