PasswordPermissions Resource

This resource represents Password Permissions in a document.

DELETE /qoppapdf/v1/documents/{filePath}.pdf/permissions/password-permissions

Clear the document's Password Permissions.

Sample Request

DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/password-permissions

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json PermissionsModel (JSON) The password Permissions.
application/xml Permissions (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/permissions/password-permissions

Get the document's Password Permissions.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/password-permissions

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json PermissionsModel (JSON) The password Permissions.
application/xml Permissions (XML)

PUT /qoppapdf/v1/documents/{filePath}.pdf/permissions/password-permissions

Set Password Permissions on the document. One or both of permissions password or open password must be set in the Password Permissions.

The message body is a PasswordPermissions JSON object.

Sample Request

 PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/password-permissions?newPermissionsPassword=permissionspassword&newOpenPassword=openpassword&currentPermissionsPassword=currentpassword&encryptType=1
 Content-Type: application/json
 (sample JSON)
 {
 	"encryptType":1,
 	"openPassword":"openPass",
 	"permissionsPassword":"permsPass",
 	"changeDocumentAllowed":false,
 	"assembleDocumentAllowed":false
 }

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Request Body
media type data type description
application/json PasswordPermissionsModel (JSON) The new Password Permissions.
application/xml PasswordPermissions (XML)
Response Body
media type data type description
application/json PermissionsModel (JSON) The password Permissions.
application/xml Permissions (XML)