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

DocumentAccessAllowed

Returns whether an action can be performed on a given document.

Syntax

Visual Basic (declaration) 
Public Function DocumentAccessAllowed( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal ActionId as  Integer) as XmlNode

C# (declaration) 
public XmlNode DocumentAccessAllowed( 
	string AuthenticationTicket,
	string Path,
	int ActionId)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string A folder path in inforouter to be tested
ActionId
    int The id of the action

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the document allows the specified action
if success = "false", the document does not allow the action. The error returns the reason or error text.

Remarks

Valid action Id List

4- Check out document
5- Add/Change Meta data
6- Remove Meta data
10- Change ownership
11- Change security
8- Change document properties
26- Read security access list
23- Read document
46- Read unpublished documents

See Also