Back to API references

SOAP API method NewDocumentPrivileges_isAllowed

Description

Returns true or false for this privilege for this role.

Parameters

Name Type Description
id * string Unique identifier (id) of the object NewDocumentPrivileges. The method only applies to the newdocumentprivileges with this id.
privilege * string Type of privileges ('use','view','edit', etc.)
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
value boolean The returned privilege.

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt