UWAGA: poniższa dokumentacja dotyczy nieakutalnej wersji API (2.0.0). Kliknij aby przejść do aktualnej dokumentacji.

<<

NAME

Group - Manage the service groups.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Group.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/Group.json

DESCRIPTION

This module allows you to create, modify and get information about your service groups.

SYNOPSIS

POST the JSONs to https://api.cloudmonit.pl/2.0.0/json_api.

See the README for more information.

        ############### create a new group ##############
        
        {                                                               {
           "auth" : {                                                      "auth" : {},
              "login" : "LOGIN",                                           "data" : {
              "password" : "PASSWORD"                                         "id" : 150507195
           },                                                              },
           "data" : {                                                      "error" : null,
              "name" : "New group"                                         "version" : "2.0.0"
           },                                                           }
           "method" : "Create",                                         
           "module" : "Group"                                           
        }                                                               
        
        
        ############### list all groups ##############
        
        {                                                               {
           "auth" : {                                                      "auth" : {},
              "login" : "LOGIN",                                           "data" : {
              "password" : "PASSWORD"                                         "elements" : [
           },                                                                    {
           "method" : "Find",                                                       "account_id" : 4913,
           "module" : "Group"                                                       "daily_reports" : 1,
        }                                                                           "default" : 1,
                                                                                    "id" : 150507194,
                                                                                    "language" : null,
                                                                                    "monthly_reports" : 1,
                                                                                    "name" : "Default group",
                                                                                    "weekly_reports" : 1
                                                                                 },
                                                                                 {
                                                                                    "account_id" : 4913,
                                                                                    "daily_reports" : 1,
                                                                                    "default" : 0,
                                                                                    "id" : 150507195,
                                                                                    "language" : null,
                                                                                    "monthly_reports" : 1,
                                                                                    "name" : "New group",
                                                                                    "weekly_reports" : 1
                                                                                 }
                                                                              ],
                                                                              "total" : 2
                                                                           },
                                                                           "error" : null,
                                                                           "version" : "2.0.0"
                                                                        }
        
        
        ############### get information about a group, including assigned location IDs ##############
        
        {                                                               {
           "auth" : {                                                      "auth" : {},
              "login" : "LOGIN",                                           "data" : {
              "password" : "PASSWORD"                                         "account_id" : 4913,
           },                                                                 "daily_reports" : 1,
           "data" : {                                                         "default" : 0,
              "id" : 150507195                                                "id" : 150507195,
           },                                                                 "language" : null,
           "method" : "Read",                                                 "location_ids" : [
           "module" : "Group"                                                    6,
        }                                                                        7
                                                                              ],
                                                                              "monthly_reports" : 1,
                                                                              "name" : "New group",
                                                                              "weekly_reports" : 1
                                                                           },
                                                                           "error" : null,
                                                                           "version" : "2.0.0"
                                                                        }
        
        
        ############### change monitoring locations ##############
        
        {                                                               {
           "auth" : {                                                      "auth" : {},
              "login" : "LOGIN",                                           "data" : {},
              "password" : "PASSWORD"                                      "error" : null,
           },                                                              "version" : "2.0.0"
           "data" : {                                                   }
              "id" : 150507195,                                         
              "location_ids" : [                                        
                 3,                                                     
                 5,                                                     
                 6                                                      
              ]                                                         
           },                                                           
           "method" : "Update",                                         
           "module" : "Group"                                           
        }                                                               
        
        
        ############### delete a group ##############
        
        {                                                               {
           "auth" : {                                                      "auth" : {},
              "login" : "LOGIN",                                           "data" : {},
              "password" : "PASSWORD"                                      "error" : null,
           },                                                              "version" : "2.0.0"
           "data" : {                                                   }
              "id" : 150507195                                          
           },                                                           
           "method" : "Delete",                                         
           "module" : "Group"                                           
        }                                                               

METHODS

Create

This method creates a new Group object.

Arguments

Returns

Delete

This method deletes a service group TOGETHER WITH ALL ITS SERVICES, NOTIFICATION AND REPORT ADDRESSES. Use with extreme caution!

The default group for the account cannot be deleted.

Arguments

Returns

Nothing.

Find

This method allows you to fetch information about selected Group objects.

Arguments

Returns

Authorization

This method can be called by read-only users.

FindLocations

Lists locations assigned to a service group.

Arguments

Returns

Authorization

This method can be called by read-only users.

Meta

Returns the JSON or WSDL specification of the Group API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

Returns

Authorization

This method can be called by read-only users.

Read

This method allows you to get information about a single Group object.

Arguments

Returns

Authorization

This method can be called by read-only users.

SetLocation

Adds a location to a group.

Arguments

Returns

Nothing.

UnsetLocation

Removes a location from a group.

Arguments

Returns

Nothing.

Update

This method updates an existing Group object.

Arguments

Returns

Nothing.

SEE ALSO

<<