W2 DocsCase Groups
⚠️ Beta: Please note case groups are still in development and are subject to change.
What is a Case Group?
A case group allows for the grouping of cases as determined by your organisation. A case group can be used for common configuration across all cases assigned to it (e.g. Monitoring). Each Case is limited to one case group. For further groupings of cases please see Tags.
The currently available configruation can be seen below.
Case Group Breakdown
| Property Name | Type | Description |
|---|---|---|
| Name | String | Name of the case group. |
| NameScreeningThreshold | Integer | The name matching score threshold. For full explanation, please see: Matching Thresholds Available values: 80,85,90,100 |
| DateOfBirthScreeningThreshold | Integer | The date of birth matching score threshold. For full explanation, please see: Matching Thresholds Available range: -100 to 100 |
| ScreeningFrequencyType | String | The frequency of screenings. Available values are: MonthlyWeeklyDailyNever |
| IsDefault | Boolean | Determines whether this case group should be default or not. When a case group is set as default, every newly created Case will be assigned to that case group. |
Create
The section below describes how to call the Create Case Group endpoint.
How to use
To call the endpoint you will need to perform a HTTP POST request to the URL:
| Url | API Version | Notes |
|---|---|---|
| 1.5 - 2.9 | Deprecated | |
| https://api.w2globaldata.com/casegroups | 3.0+ | Current |
Example Request
{
"CaseGroup": {
"Name":"Case Group 152"
,"NameScreeningThreshold" : 80
,"DateOfBirthScreeningThreshold" : 60
,"ScreeningFrequencyType" : "Monthly" //Monthly,Weekly,Daily,AdHoc,Never
,"IsDefault": false
}
}Example Response
{
"caseGroup": {
"id": "xxxx0dd6-a8b4-xxx4-a6xx-5xxx7c8xxxxc",
"name": "Case Group 152",
"NameScreeningThreshold" : 80,
"DateOfBirthScreeningThreshold" : 60,
"screeningFrequencyType": "Monthly",
"isDefault": false
}
}A case group will be created.
Get
The section below describes how to call the Get Case Group endpoint.
How to use
To call the endpoint you will need to perform a HTTP GET request to the URL:
| Url | API Version | Notes |
|---|---|---|
| 1.5 - 2.9 | Deprecated | |
| https://api.w2globaldata.com/casegroups | 3.0+ | Current |
A list of your case groups will be provided if any exist.
Example Response
[
{
"id": "cxxxxdd6-a8b4-xx24-a619-5xxxxc89axxx",
"name": "Case Group 152",
"screeningFrequencyType": "Monthly",
"isDefault": false
},
{
"id": "4xxxxb48-259d-xxx0-9877-d3xxxx9f1363",
"name": "Case Group 79",
"nameScreeningThreshold": 80,
"screeningFrequencyType": "Weekly",
"isDefault": true
},
{
"id": "cxxxxd3a-xxd7-4xx4-abb8-8fxxxxcaaed5",
"name": "Testing Group 27",
"screeningFrequencyType": "Daily",
"isDefault": false
},
{
"id": "98xxxx8c-a39f-xx22-b1xx-d93xxxxxb5d7",
"name": "Testing Group 20",
"screeningFrequencyType": "Never",
"isDefault": false
},
{
"id": "1xxxxc20-9xx2-4756-bf33-exxxx70xxxx7",
"name": "Test group 5",
"nameScreeningThreshold": 38,
"dateOfBirthScreeningThreshold": 0,
"screeningFrequencyType": "Daily",
"isDefault": false
}
]