Skip to content
On this page

Risk Groups

What is a Risk Group?

A risk group allows for the classification of cases by risk as determined by your organisation.

Create

The section below describes how to call the Create Risk Group endpoint.

How to use

To call the endpoint you will need to perform a HTTP POST request to the URL:

API VersionUrl
1.5https://api.w2globaldata.com/riskgroups?api-version=1.5 Latest

Example Response

json

{
    "riskGroup": {
        "name": "high"
    }
}

A risk group will be created.

Get

The section below describes how to call the Get Risk Group endpoint.

How to use

To call the endpoint you will need to perform a HTTP GET request to the URL:

API VersionUrl
1.5https://api.w2globaldata.com/riskgroups?api-version=1.5 Latest

A list of your risk groups will be provided if any exist.

Example Response

json
[
    {
        "id": "09e8dca6-e3f5-11eb-ba80-0242ac130004",
        "name": "High"
    },
    {
        "id": "1d394f16-e3f5-11eb-ba80-0242ac130004",
        "name": "Medium"
    },
    {
        "id": "2175912a-e3f5-11eb-ba80-0242ac130004",
        "name": "Low"
    }
]