SOAP API method SmsDocument_privileges

Description

The privileges for a certain (user) role. If the role is not supplied, the privileges of a new role will be returned.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object SmsDocument. The method only applies to the smsdocument 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
user	Structure of type 'user'	The user for which the privileges should be returned
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
* required parameters

Return values

Name	Type	Description
privileges	Structure of type 'privileges'

Structure 'user'

Name	Type	Description
id	int	The ID of the user.
created	timestamp	The timestamp when the user is created.
end	timestamp	The timestamp when the user is ended.
gender	string	The gender of the user.
name	string	The name of the user.
description	string	The description of the user.
email	string	The email address of the user.
phone	string	The phone number of the user.
sms	string	The sms number of the user.
fax	string	The fax number of the user.
applicationadmin	boolean	Returns if the user is application admin.
accountadmin	boolean	Returns if the user is account admin.
styleadmin	boolean	Returns if the user is style admin.
dummy	boolean	Returns if the user is a dummy user.
apiaccess	boolean	Returns if the user has access to the API.
uiacess	boolean	Returns if the user has access to the user interface.
disabled	boolean	Is this user disabled?.
active	boolean	Is this user active?
receivenews	boolean	Will this user receive the news?.
language	string	The prefered language of the user.
timezone	string	Get the timezone for the user. If no timezone is set an empty string is returned.
unsecure	boolean	Is this an insecure user?.

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 'privileges'

Name	Type	Description
id	string	The id of the privileges object.
rights	string	The access rights for this privileges object.