SOAP API method PdfDocument_property
Description
Get a single property of the document.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id. |
personalize_profile | int | Profile ID for which the object should be personalized |
personalize_subprofile | int | Subprofile ID for which the object should be personalized |
personalize_timestamp | string | The timestamp for the personalization |
emailingtemplateproperty | Structure of type 'emailingtemplateproperty' | |
pdftemplateproperty | Structure of type 'pdftemplateproperty' | |
name | int | |
name | string | |
defaultValue | boolean | Get the default value of the propery is no value is set. Default false |
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 | string | value |
Structure 'emailingtemplateproperty'
Name | Type | Description |
---|---|---|
id | string | The ID of the property. |
name | string | The name of the property. |
type | string | The type of the property. |
defaultValue | string | The default value of the property |
Structure 'pdftemplateproperty'
Name | Type | Description |
---|---|---|
id | string | The ID of the property. |
name | string | The name of the property. |
type | string | The type of the property. |
defaultValue | string | The default value of the property |
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 |