Package - check your account's limits
WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Package.wsdl
JSON: https://api.cloudmonit.pl/2.0.0/json/Package.json
This API module allows you to retrieve information about your package, which defines various limits for your account.
Lists available packages (your package if you are an user or packages available to create new accounts if you are a distributor)
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: id,
max_locations_limit,
max_services,
max_sms_numbers,
min_interval,
min_locations_limit,
name,
user_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: id,
max_locations_limit,
max_services,
max_sms_numbers,
min_interval,
min_locations_limit,
name.
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:
Service check intervals available in the package.
An array of unsigned integers.
The package's identifier. You have to specify it if you are a distributor, otherwise your account's package ID will be used.
The maximum number of locations that can be assigned to a single services group.
The maximum number of services.
The SMS numbers limit for each group.
The minimal interval between service checks that can be assigned to a service.
The minimum number of locations that have to be assigned to a single services group.
The name of the package.
Allowed notification channels.
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 total number of results (not including pagination).
This method can be called by read-only users.
Returns the JSON or WSDL specification of the Package 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 Package object.
The package's identifier. You have to specify it if you are a distributor, otherwise your account's package ID will be used.
The groups of fields to be returned with the object.
An array of strings.
Allowed values are: service_types.
This array cannot contain duplicate values.
Defaults to [] if not specified.
Service check intervals available in the package.
An array of unsigned integers.
The package's identifier. You have to specify it if you are a distributor, otherwise your account's package ID will be used.
The maximum number of locations that can be assigned to a single services group.
The maximum number of services.
The SMS numbers limit for each group.
The minimal interval between service checks that can be assigned to a service.
The minimum number of locations that have to be assigned to a single services group.
The name of the package.
Allowed notification channels.
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.
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.