SOAP API method WebSite_forbiddenDocument

Description

The document that is configured as the forbidden page.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object WebSite. The method only applies to the website with this id.
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
* required parameters

Return values

Name	Type	Description
webdocument	Structure of type 'webdocument'

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

Structure 'webdocument'

Name	Type	Description
loginrequired	boolean	The page is only available for logged in profiles or subprofiles.
enabled	boolean	Page enabled.
charset	string	Gets the charset that should be used when showing/sending this document
htmlEscaping	string	Check if the document is escaping HTML code
smartyVersion	integer	What smarty version is used to render this document
id	int	The ID of the document.
templateID	int	The template ID of the document
name	string	The name of the document.
description	string	The description of the document.
archived	boolean	Is this an archived document?.
created	timestamp	The date and time when the document was created.
modified	timestamp	The date and time when the document was last modified.
language	string	The language of the document.
timezone	string	Get the time zone of the document. If the timezone is not set, it returns