Error Summary
Error Summary tables for the API's are listed below.
Suspense API and Withholding API
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
The resource '{Suspense+SuspenseGuid}' does not exist. For Withholding: The resource '{Withholding+WithholdingGuid}' does not exist |
This error occurs when user is trying to read or update a { suspense/Withholding} resource which does not exist. | This issue can be fixed by providing a valid {suspenseId/WithholdingId} in the URL. |
| The '{queryParameter}' for resource '{resourcename}' does not exist. | This error occurs when the parameter used in the URL query path is not valid for the resource. | This issue can be fixed either by removing the invalid query parameter or by passing a valid parameter in the URL query path. |
| The resource '{Withholding}' with '{Withholding+WithholdingGuid}' already exists. | This error occurs when Withholding already exists for a policy and user tried to create another Witholding object for the same policy. | User can verify if the Policy Withholding already exist for the policy. If Withholding already exists user can update the Withholding using PUT method. |
| The resource '{Withholding}' cannot be updated when parent Policy '{PolicyGuid}' is in {StatusCode} Status. | This error occurs when user updates a withholding and WithholdingScreen Business rule is configured to disable withholding fields when parent Policy is in specified Status codes. | This error can be fixed by verifying the withholding Id and Policy Id to see the request is being passed to the correct Policy or Withholding. (or) by updating the WithholdingScreen rule to allow updates to Withholding when policy is in current Status. |
| Update not allowed for field {fieldName} for resource {resourceName} | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
| The resource '{Withholding + WithholdingGuid}' is not associated with '{Policy + PolicyGuid}'. | This error occurs when user provided a withholding id and Policy Id in the URL but the WithhodlingId is not associated to the PolicyId. | This error can be fixed by verifying if the WithholdingId is associated to the PolicyId provided in the URL and by updating the WithholdingId if needed. |
| Deleting suspense { suspenseId} is not allowed as the suspense has child suspenses or the suspense is used in Policy. | This error occurs when user tried to delete master suspenses when the suspense has child suspenses to it. And also Deleting a suspense is not allowed when a suspense is associated to the policy. | This error can be fixed by deleting the child suspenses before deleting a master. (or) Verify if the correct suspenseId is used. |
WorkflowTasks API
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
The '{resource + resourceId}' does not exist. |
This error occurs when user tries to read or update a { WorkflowTaskDefinition/WorkflowTask} resource that does not exist. | This issue can be fixed by providing a valid {WorkflowTaskDefinition/WorkflowTask} Id in the URL. |
| The '{resource}' with '{resourceName}' task type already exists. | This error occurs when Workflow already exists for an entity and user tried to create another Workflow Task with the same WorkflowTaskDefinition. | User can verify if the Workflow Task with the same Task Type already exist for the entity. If Workflow Task already exists user can update the WorkflowTask using PUT or PATCH method. |
| Update not allowed for field {fieldName} for resource {resourceName}. | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
| Adding or updating {workflowTask} with {WorkflowTaskDefinition} creational method value 'Automatic' is not allowed. | This error occurs when user tried to Post or Put WorkflowTask using WorkflowTaskDefinition for which CreationalMethod is defined as Automatic. |
This error can be fixed either by changing the WorkflowTaskDefinition CreationalMethod value to MANUAL or BOTH. (or) The error can be fixed by using a different WorkflowTaskDefinition with CreationalMethod value as MANUAL or BOTH. |
| User { username} does not have authorization to create/read/update WorkflowTask with workflowTaskDefinition {TaskName}. | This error occurs when user tried to Create/Update/Read a workflowTask and the user is not associated to the WorkflowDefinition's role. | This error can be fixed by associating the user to the WorkflowTaskDefinition role or use a user who is associated to the WorkflowTaskDefinition role. |
| WorkflowTask cannot be updated to {workflowstatus} without 'AssignedTo' value. | This error occurs when user tried to update WorkflowTask to Pending, Assigned, Reassigned without providing AssignedTo value in request payload. | This error can be fixed by providing AssignedTo value in the request payload for WorkflowTask. |
| The '{queryParameter}' for resource '{resourcename}' does not exist. | This error occurs when the parameter used in the URL query path is not valid for the resource. | This issue can be fixed either by removing the invalid query parameter or by passing a valid parameter in the URL query path. |
| {user} is not associated with any workflow role. | This error occurs when user is not associated with any workflow role and the user tried to read, update or create a workflowTask. | This issue can be fixed by associating the user with workflow role before performing any operations on Workflow. |
RateGroups API
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
The resource '{RateGroup+RateGroupGuid}' does not exist. |
This error occurs when user is trying to read or update a Rate Group resource which does not exist. | This issue can be fixed by providing a valid {RateGroupId} in the URL. |
| The '{queryParameter}' for resource '{resourcename}' does not exist. | This error occurs when the parameter used in the URL query path is not valid for the resource. | This issue can be fixed either by removing the invalid query parameter or by passing a valid parameter in the URL query path. |
| Update not allowed for field {fieldName} for resource {resourceName}. | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
| RateGroupRelationship already exists for same entity. | This error occurs when user tries to create RateGroupRelationship with same EntityId, EntityCode and PurposeCode and the RateGroupRelationship on the RateGroup already exists with same parameters. |
This error can be fixed by changing either the RateGroupId or the RateGroupRelationship EntityId and EntityCode or PurposeCode. |
| The resource '{rateGroup + rateGroupGuid}' is not associated with '{rate + rateGuid}'. | This error occurs when user provided a RateId and RateGroupId in the URL but the RateId is not associated with the RateGroupId. | This error can be fixed by verifying if the RateId is associated to the RateGroupId provided in the URL and by updating the RateId or RateGroupId if needed. |
| The resource '{rateGroup + rateGroupGuid}' is not associated with '{rateGroupRelationship + rateGroupRelationshipId}'. | This error occurs when user provided a RateGroupRelationshipId and RateGroupId in the URL but the RateGroupRelationshipId is not associated with the RateGroupId. | This error can be fixed by verifying if the RateGroupRelationshipId is associated to the RateGroupId provided in the URL and by updating the RateGroupRelationshipId or RateGroupId if needed.. |
| Value given for 'Table Format' is not valid. | 'Table format' accepts AGGREGATE, SELECT, ULTIMATE as values .This error occurs when user provides any other value for the Table format. | This error can be fixed by providing a valid value for 'Table Format'. |
| Secondary index is not required when table format value is 'AGGREGATE'. | This error occurs when user provides value for Secondary index and Table format is selected as AGGREGATE. | This error can be fixed by changing the value of either Table format or by giving the value of Secondary index as null. |
| Value given for Secondary index is invalid. | This error occurs when user provided Secondary index but the value is not defined as Criteria for the RateGroup. | This error can be fixed by updating the secondary index value to one of the defined criteria. Or update a Criteria with Secondary Index value. |
| Secondary Index is required. | This error occurs when user does not provide value for Secondary Index in the request and the Table Format given is SELECT or ULTIMATE. | This error can be fixed by providing a value to Secondary Index in the request or change the Table Format to Aggregate. |
| {ActiveToDate/ExpirationDate} {date} is before EffectiveDate {date} of the RateGroup. | ActiveToDate or ExpirationDate cannot be less than EffectiveDate for a RateGroup. This error occurs when user provided ActiveToDate or Expirationdate prior to rate EffectiveDate for a RateGroup. | This error can be fixed by providing ActiveToDate or ExpirationDate Greater than EffectiveDate for a RateGroup. |
| The criteria defined in the request did not match the Criteria value set in the system. | The number of Criteria defined in the request is less than or greater than the number of Criteria set in the system. | This error can be fixed by defining the same number of Criteria in the RateGroups to match with the number defined in AsCodeRateCriteriaColumns. |
| RateGroup with same Rate Description and Rate Activation already exists. | This error occurs when Rate Group with same Rate description and rate activation already exists in the data base. | This error can be fixed by updating the Rate Description or Rate Activation Date with different values. |
| {EntityTypeCode/PurposeCode} given for the RateGroupRelationship is not valid. | This error occurs when user tried to provide a value for {EntityTypeCode/PurposeCode} fields in the request and the value is not predefined in OIPA. | This error can be fixed by providing valid values to {EntityTypeCode/PurposeCode}. |
| EntityId is invalid. | This error occurs when user provided an EntityId for RateGroupRelationship and the EntityId is invalid for the EntityType. | This error can be fixed by providing valid EntityId in the request for RateGroupRelationship. |
Requirement Results API
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
The resource '{RequirementGuid}' does not exist. For Requirement Result: The resource '{RequirementResultGuid}' does not exist |
This error occurs when user is trying to read or update a {Requirement/RequirementResult} resource which does not exist. | This issue can be fixed by providing a valid {requirementId/requirementResultId} in the URL. |
| The '{queryParameter}' for resource '{resourcename}' does not exist. | This error occurs when the parameter used in the URL query path is not valid for the resource. | This issue can be fixed either by removing the invalid query parameter or by passing a valid parameter in the URL query path. |
| Update not allowed for field {fieldName} for resource {resourceName}. | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
| The resource 'requirementDefinitionId' is not present. | This error is caused when the user is trying to create the requirementResult. | This error can be fixed by providing requirementDefinitionId. |
Policy level and Client level Requirement Results API
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
The resource '{RequirementGuid}' does not exist. |
This error occurs when user is trying to read or update a {Requirement} resource which does not exist. | This issue can be fixed by providing a valid {RateGroupId} in the URL. |
| The '{queryParameter}' for resource '{resourcename}' does not exist. | This error occurs when the parameter used in the URL query path is not valid for the resource. | This issue can be fixed either by removing the invalid query parameter or by passing a valid parameter in the URL query path. |
| Update not allowed for field {fieldName} for resource {resourceName}. | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
Patch API's for multiple entities
Table - Error Summary
| Error Message | Error Cause | Error Fix Tip |
|---|---|---|
|
Invalid Field {FieldName} for resource {resourcename} |
This error occurs when field {fieldName} is not valid for the resource {resourceName}. | This error can be fixed by providing a valid ClientId for resource {resourceName} and {fieldName}. |
| Invalid Client{ClientID} | This error occurs when user provided a clientID which does not exist in the system while updating a Role resource. | This error can be fixed by providing a valid ClientID in the Role request body. |
| Update not allowed for field {fieldName} for resource {resourceName} | This error occurs when user tried to update a field using partial payload and the field is not allowed for PATCH update. | This error can be fixed by verifying if the fields in the partial payload are allowed for PATCH update or User can update the fields using PUT method. |
| MultiFields are not applicable for the resource {resourcename} | This error occurs when user tried to update Multifields using PATCH and Multifields are not applicable for the resource {resourcename}. | This error can be fixed by removing Multifields if Multifields are not applicable for the resource. |
| The field {fieldname} in Group {Groupname} is not present in the entity {entityname} Multifields | This error occurs when user tried to update a field that is not present within the Multi Field Group {groupname} specified for the entity {entityname}. | This error can be fixed by providing the valid field for the Group present in the MultiValuefield used for the entity. (or) User can verify if the Group name provided is correct and change the group name used in the update request. |
| Multifield index $[indexvalue] not found for MultiField group {groupname} for the entity {entityname}. | This error occurs when user tried to update a Multifield record and specified multifield Index and the Index is not found. | This error can be fixed by correcting the Multifield Index (or) verify the Multifield Index if it is available for the entity. |