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
- Parameter 'id' : int
- Unique identifier (id) of the object SmsDocument. The method only applies to the smsdocument with this id.
- Parameter 'personalize_profile' : int
- Profile ID for which the object should be personalized
- Parameter 'personalize_subprofile' : int
- Subprofile ID for which the object should be personalized
- Parameter 'personalize_timestamp' : string
- The timestamp for the personalization
- Parameter 'user' : Structure of type 'user'
- The user for which the privileges should be returned
- Parameter 'login' : Structure of type 'login'
- Optional login data
Return values
- Return value 'privileges' : Structure of type 'privileges'
Structure 'user'
This structure user was mentioned above. This structure has the following properties:
- Property 'id' : int
- The ID of the user.
- Property 'created' : timestamp
- The timestamp when the user is created.
- Property 'end' : timestamp
- The timestamp when the user is ended.
- Property 'gender' : string
- The gender of the user.
- Property 'name' : string
- The name of the user.
- Property 'description' : string
- The description of the user.
- Property 'email' : string
- The email address of the user.
- Property 'phone' : string
- The phone number of the user.
- Property 'sms' : string
- The sms number of the user.
- Property 'fax' : string
- The fax number of the user.
- Property 'applicationadmin' : boolean
- Returns if the user is application admin.
- Property 'accountadmin' : boolean
- Returns if the user is account admin.
- Property 'styleadmin' : boolean
- Returns if the user is style admin.
- Property 'dummy' : boolean
- Returns if the user is a dummy user.
- Property 'apiaccess' : boolean
- Returns if the user has access to the API.
- Property 'uiacess' : boolean
- Returns if the user has access to the user interface.
- Property 'disabled' : boolean
- Is this user disabled?.
- Property 'active' : boolean
- Is this user active?
- Property 'receivenews' : boolean
- Will this user receive the news?.
- Property 'language' : string
- The prefered language of the user.
- Property 'timezone' : string
- Get the timezone for the user. If no timezone is set an empty string is returned.
- Property 'unsecure' : boolean
- Is this an insecure user?.
Structure 'login'
This structure login was mentioned above. This structure has the following properties:
- Property 'username' : string
- The username of the login attempt
- Property 'account' : string
- The account name of the login attempt
- Property 'password' : string
- The password for the login attempt
Structure 'privileges'
This structure privileges was mentioned above. This structure has the following properties:
- Property 'id' : string
- The id of the privileges object.
- Property 'rights' : string
- The access rights for this privileges object.