Hold Violation Result Details

Output representation of the information related to the list of hold result items.

JSON Example 

1{
2  "violations": [
3    {
4      "caseId": "string",
5      "description": "string",
6      "regulatoryCodeViolationId": "string",
7      "regulatoryCodeId": "string",
8      "regulatoryCodeName": "string",
9      "dateCreated": "2025-07-24T18:35:18.820Z",
10      "complianceDueDate": "2025-07-24T18:35:18.820Z",
11      "dateResolved": "2025-07-24T18:35:18.820Z",
12      "daysOpen": 0,
13      "reasons": [
14        {
15          "name": "RegulationClauseName",
16          "id": "0x6frr566",
17          "isRuleDriven": false
18        }
19      ],
20      "restrictions": [
21        {
22          "name": "Enrollment",
23          "id": "0x7fsss66",
24          "isRuleDriven": true,
25          "isExecuted": true
26        },
27        {
28          "name": "FeePayment",
29          "id": "0x7fsss67",
30          "isRuleDriven": false,
31          "isExecuted": false
32        }
33      ],
34      "resolution": {
35        "id": "string",
36        "name": "string",
37        "numberOfTasks": 0,
38        "numberOfOverdueTasks": 0,
39        "status": "string",
40        "startDate": "2025-07-24T18:35:18.820Z",
41        "endDate": "2025-07-24T18:35:18.820Z",
42        "allowOverride": true,
43        "tasks": [
44          {
45            "id": "string",
46            "taskParentName": "string",
47            "relatedTo": "string",
48            "subject": "string",
49            "status": "string",
50            "priority": "string",
51            "dueDate": "2025-07-24T18:35:18.820Z",
52            "createdDate": "2025-07-24T18:35:18.820Z",
53            "description": "string",
54            "completedDateTime": "2025-07-24T18:35:18.820Z"
55          }
56        ]
57      }
58    }
59  ]
60}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
caseIdStringUnique ID of the case associated with the hold violation.Big, 64.064.0
compliance​DueDateStringDate by which compliance is required to address the violation.Big, 64.064.0
dateCreatedStringDate and time when the violation record was created.Big, 64.064.0
dateResolvedStringDate and time when the violation was resolved.Big, 64.064.0
daysOpenIntegerNumber of days the violation remained open before being resolved.Big, 64.064.0
descriptionStringDescription of the violation record.Big, 64.064.0
reasonsHold Result Output Items[]Reason for the hold result.Big, 64.064.0
regulatoryCode​IdStringUnique ID of the regulatory code associated with the violation.Big, 64.064.0
regulatory​CodeNameStringName of the regulatory code associated with the violation.Big, 64.064.0
regulatoryCode​ViolationIdStringUnique ID of the violation record.Big, 64.064.0
resolutionAction PlanDetails about the action plan to resolve the violation.Big, 64.064.0
restrictionsHold Result Output Items[]Restriction associated with the hold result.Big, 64.064.0