Account - manage your account
WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Account.wsdl
JSON: https://api.cloudmonit.pl/2.0.0/json/Account.json
This API module allows you to configure and retrieve information about user accounts.
Activates an account. You need to login as a distributor to do this.
The account's identifier (in the old API known as uid).
Nothing.
Blocks an account. You need to login as a distributor to do this. Blocked accounts cannot be accessed by users until unblocked, their services are paused.
The account's identifier (in the old API known as uid).
Nothing.
Creates a new account. You need to login as a distributor to do this. The new account is inactive by default; it needs to be activated by the Account::Activate method. Creating an account requires the account user's data to be specified and creates a new User.
The user's address.
The person to contact about the account (the user's name).
The user's phone number.
Defaults to "" if not specified.
The user's e-mail address.
This value must be a valid e-mail address.
The default reports and notifications language for the account's user.
Allowed values are: en,
pl.
The user's login.
This value cannot be an empty string.
The name of the account.
The account package's identifier (account limits).
The user's password.
The user's tax identification number.
The account's identifier (in the old API known as uid).
Permanently deletes an account with all its groups, services etc. Only distributors can do this.
The account's identifier (in the old API known as uid).
Nothing.
This method allows you to fetch information about selected Account objects.
Filters to apply to the results.
An array of objects, each containg the fields:
The filter argument (the text to be contained in the field, or value to be compared). The argument must be of the same type as the field you filter by.
The field to filter the results by.
Allowed values are: activated,
blocked,
id,
name,
package_id.
The type of filter. Filters (not_)greater_than and (not_)lower_than compare numbers numerically and string lexicographically. Defaults to "equals".
Allowed values are: contains,
equals,
greater_than,
lower_than,
not_greater_than,
not_lower_than.
Maximum array length: 10.
Items per page. If not specified, NULL or 0, all elements will be fetched. You should probably specify results ordering as well, if you want the results to be consistent.
The index of the first element to show on page.
Items are numbered starting from 0.
Default is 0.
Only meaningful if limit is specified as well.
Fields to order the results by, starting from the most significant.
An array of objects, each containg the fields:
The ordering direction, "ascending" or "descending".
Allowed values are: ascending,
descending.
Defaults to "ascending" if not specified.
The field to order by. If not specified, the results can be returned in any order.
Allowed values are: activated,
blocked,
id,
name,
package_id.
Maximum array length: 10.
The groups of fields to be returned with each object.
An array of strings.
No values are supported at the moment.
This array cannot contain duplicate values.
Defaults to [] if not specified.
An array of objects, each containg the fields:
Whether the account has been activated or not.
Whether the account has been blocked or not.
The account's identifier (in the old API known as uid).
The name of the account.
The account package's identifier (account limits).
The total number of results (not including pagination).
This method can be called by read-only users.
Returns the JSON or WSDL specification of the Account API module.
This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.
The specification format you want to use.
If omitted,
defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.
Allowed values are: json,
wsdl.
The specification of the module.
The specification format used.
Allowed values are: json,
wsdl.
This method can be called by read-only users.
This method allows you to get information about a single Account object.
The account's identifier (in the old API known as uid).
The groups of fields to be returned with the object.
An array of strings.
Allowed values are: limits,
service_types.
This array cannot contain duplicate values.
Defaults to [] if not specified.
Whether the account has been activated or not.
Service check intervals available in the package.
You have to include limits in the with argument to fetch this field.
An array of unsigned integers.
Whether the account has been blocked or not.
The account's identifier (in the old API known as uid).
The maximum number of locations that can be assigned to a single services group.
You have to include limits in the with argument to fetch this field.
The maximum number of services.
You have to include limits in the with argument to fetch this field.
The SMS numbers limit for each group.
You have to include limits in the with argument to fetch this field.
The minimal interval between service checks that can be assigned to a service.
You have to include limits in the with argument to fetch this field.
The minimum number of locations that have to be assigned to a single services group.
You have to include limits in the with argument to fetch this field.
The name of the account.
Allowed notification channels.
You have to include limits in the with argument to fetch this field.
An array of strings.
Allowed values are: email_extended,
email_long,
email_short,
email_simplified,
gadu_gadu,
hipchat,
jabber,
json_post,
push,
sms.
This array cannot contain duplicate values.
The account package's identifier (account limits).
You have to include service_types in the with argument to fetch this field.
An array of objects, each containg the fields:
The service type identifier.
The maximum number of services of the type that are allowed to create for accounts with the package.
The minimum checks interval for services of the type allowed for accounts with the package.
The type name.
This method can be called by read-only users.
Unblocks an account. You need to login as a distributor to do this. Unblocked accounts can be logged to, but their services have to be unpaused manually.
The account's identifier (in the old API known as uid).
Nothing.
Updates an account's information.
The account's identifier (in the old API known as uid).
The name of the account.
Nothing.