Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
143 lines (115 sloc) 4.56 KB

REST API: GET view rules

To retrieve all rules in a selection, send a HTTP GET request to this address:

https://api.copernica.com/v2/view/$id/rules?access_token=xxxx

The $id code should be replaced with the numeric identifier of the selection from which you want to retrieve the rules.

Supported parameters

You can add one or more of the following parameters to the URL:

  • start: the first rule to fetch
  • limit: max size of the requested batch
  • total: show/hide the total number of matching rules

You can find more information about the start, limit and total parameters in our paging article.

Returned fields

This method returns a JSON object with an array of rules in the data field. Each rule contains the following fields:

  • ID: ID of the rule
  • name: Name of the rule
  • view: ID of the selection to which the rule belongs
  • disabled: Boolean value whether the rule is disabled / not used to match profiles
  • inverted: Boolean value whether this is an inverted rule, meaning that profiles are included in the rule if they do not match the rule
  • conditions: Array of conditions in the rule

Conditions

A rule on its own contains conditions. For a profile to match a rule, it has to match all the conditions. The conditions property that is returned by this method holds an array of condition objects, with the following properties per condition:

  • ID: numeric ID of the condition
  • type: condition type
  • rule: numeric ID of the rule to which the condition belongs

Based on the condition type, specific properties are set. Specific condition types are discussed in separate articles, which are linked in the "More information" section.

JSON example

The JSON for a single rule looks something like this:

{  
    "ID":"4012",
    "name":"Rule",
    "view":"4184",
    "conditions":{  
    "start":0,
    "limit":100,
    "count":1,
    "data":[  
        {  
            "ID":"2110",
            "type":"Field",
            "rule":"4039",
            "comparison":"equals",
            "field":{  
                "ID":"22142",
                "name":"subscribed",
                "type":"text",
                "value":"no",
                "displayed":false,
                "ordered":false,
                "length":"255",
                "textlines":"3",
                "hidden":false,
                "index":false
            },
            "value":"yes",
            "other-field":false,
            "numeric-comparison":false
        }
    ],
    "total":1
    },
    "inversed":false,
    "disabled":false
}

PHP example

The following script can be used to fetch rules from a selection. The CopernicaRestApi class that we use in the example takes care of escaping the parameters that are passed to the URL. If you write your own code to construct the URL, you must take care of escaping the parameters yourself.

// dependencies
require_once('copernica_rest_api.php');
    
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 2);

// parameters to pass to the call
$parameters = array(
    'limit'     =>  100,
);
    
// do the call, and print result
print_r($api->get("view/{$viewID}/rules", $parameters));

The example above requires the CopernicaRestApi class.

More information

Since there are many condition types which behave very differently each condition type is explained in a separate article below.