NotificationAddress - Manage the notifications.
WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/NotificationAddress.wsdl
JSON: https://api.cloudmonit.pl/2.0.0/json/NotificationAddress.json
This module allows you to manage the notification addresses that will be used to inform you about service breakdowns, recoveries and other important events.
This method creates a new NotificationAddress object.
The notification address. It can be an e-mail address, GG number, Jabber ID or phone number, depending on the address' type.
The ID of the group the notification address is assigned to. The group cannot be changed once the address is created, if you want to assign the address to another group, you'll have to delete the existing one first.
The identifier of the notification channel for this address.
Allowed values are: email_extended
,
email_long
,
email_short
,
email_simplified
,
gadu_gadu
,
hipchat
,
jabber
,
json_post
,
sms
.
The identifier of the notification address.
This method deletes a NotificationAddress object. Use with caution.
The identifier of the notification address.
Nothing.
This method allows you to fetch information about selected NotificationAddress 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: address
,
group_id
,
id
,
notification_channel
.
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: address
,
group_id
,
id
,
notification_channel
.
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:
The notification address. It can be an e-mail address, GG number, Jabber ID or phone number, depending on the address' type.
The ID of the group the notification address is assigned to. The group cannot be changed once the address is created, if you want to assign the address to another group, you'll have to delete the existing one first.
The identifier of the notification address.
The identifier of the notification channel for this address.
Allowed values are: email_extended
,
email_long
,
email_short
,
email_simplified
,
gadu_gadu
,
hipchat
,
jabber
,
json_post
,
sms
.
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 NotificationAddress
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 NotificationAddress object.
The identifier of the notification address.
The groups of fields to be returned with the object.
An array of strings.
No values are supported at the moment.
This array cannot contain duplicate values.
Defaults to []
if not specified.
The notification address. It can be an e-mail address, GG number, Jabber ID or phone number, depending on the address' type.
The ID of the group the notification address is assigned to. The group cannot be changed once the address is created, if you want to assign the address to another group, you'll have to delete the existing one first.
The identifier of the notification address.
The identifier of the notification channel for this address.
Allowed values are: email_extended
,
email_long
,
email_short
,
email_simplified
,
gadu_gadu
,
hipchat
,
jabber
,
json_post
,
sms
.
This method can be called by read-only users.
This method updates an existing NotificationAddress object.
The notification address. It can be an e-mail address, GG number, Jabber ID or phone number, depending on the address' type.
The identifier of the notification address.
The identifier of the notification channel for this address.
Allowed values are: email_extended
,
email_long
,
email_short
,
email_simplified
,
gadu_gadu
,
hipchat
,
jabber
,
json_post
,
sms
.
Nothing.