1. Home / Web Services API Version 8.x / SetDocumentCompletionStatus

SetDocumentCompletionStatus

Sets the completion status of the specified document.

Syntax

Visual Basic (declaration) 
Public Function SetDocumentCompletionStatus( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal PercentComplete as String, _ 
	ByVal CompletionDate as datetime) as XmlNode

C# (declaration) 
public XmlNode SetDocumentCompletionStatus( 
	string AuthenticationTicket,
	string Path,
	string PercentComplete,
	datetime CompletionDate)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string The Path of a document
PercentComplete
    string Specifies percent complete value. (0-100) integer value
CompletionDate
    datetime Specifies the date of the completion. if document is completed.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the completion status has been updated successfully.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

Completion Date must be 1900-1-1 for the incomplete documents
The caller must be have at least "Change" permission on the document.

See Also