List Portfolio Event Rules By Country

Request

Endpoint that lists all the eventRules, their status, and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio.

For guidance on how to use event rules with PARAM prefixes and to understand rule parameters, see the documentation here: Special Event Rules. For example, global rule 101 may require specific PARAM values as described in the linked documentation.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

countryCodestring, = 2 charactersrequired

Country code to show events for.
Please note that there is one exception in that PLC is the only 3-character that can be accepted here.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

Array [

isActiveboolean

Shows whether the notification event rule has been enabled for the given portfolio.

Example:0

ruleCodenumber

The unique identifier for the notification event rule.

Example:101

ruleCountryCodestring

The ISO/Alpha 2 format country code for the notification event rule. "XX" is used for global rules that apply to companies from all countries.

Example:"XX"

ruleTypenumber

The unique identifier of the ruleType for the notification event rule.

Example:4

ruleTypeNamestring

A short description of the ruleType for the notification event rule.

Example:"Rating band change - 3 input"

namestring

The name for the notification event rule.

Example:"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"

param0string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:"1"

param1string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:"A"

param2boolean

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:true

]

Response

[
  {
    "isActive": 0,
    "ruleCode": 101,
    "ruleCountryCode": "XX",
    "ruleType": 4,
    "ruleTypeName": "Rating band change - 3 input",
    "name": "International Rating | Reduce by {0} Band(s) OR Less than Band {1}",
    "param0": "1",
    "param1": "A",
    "param2": true
  }
]