InsCensusServiceStd:addPlanSelections

How It Works

The service uses censusId and contractId to insert members' selected plans.

1. For each of its ContractGroupPlan IDs, the service evaluates whether the plan is valid for the member based on these factors:

   • The contractId is valid for the censusId.

   • The ​ContractGroupPlan​​ Id is valid for the ​contractId​.

   • IsOptOutAllPlans is false.

   • When ContractGroupPlan has record type as Product (ContractGroupPlan of parent):

     • The product type of the ​​ContractGroupPlan​​ for the primary member must not be equal to the product types listed in the primary member's ​OptOutPlanTypes​​.

     • The product type of the ​​ContractGroupPlan​​ for a dependent must not be equal to the product types listed in the dependent's ​OptOutPlanTypes​​, and the product type of the ​ContractGroupPlan​​ must not be equal to the product types listed in the ​OptOutPlanTypes​​ of dependent's primary member.

   • When ContractGroupPlan has record type as CoverageSpec (ContractGroupPlan of child):

     • The product type of the ​​ContractGroupPlan​​ of a child for the primary member must not be equal to the product types listed in the primary member's ​OptOutPlanTypes​​.

     • The product type of the ​​ContractGroupPlan​​ of a child for a dependent must not be equal to the product types listed in the dependent's ​OptOutPlanTypes​​, and the product type of the ​ContractGroupPlan​​ must not be equal to the product types listed in the ​OptOutPlanTypes​​ of dependent's primary member.

2. The Ids of successfully created GroupCensusMemberPlan entries are returned for valid plans.

3. The service retrieves the valid plans for eligible group classes for the given contract. Enrollment in a root plan and its coverages depends on whether the member's class is eligible for the plan, and if the plan accepts members not associated with any class.

   If the service determines that a census member can enroll in a plan, the plan is added to the GroupCensusMemberPlan.

   • A plan is added to a GroupCensusMemberPlan if:

     • A census member is associated with a valid group class and a ContractGroupPlanGroupClass record exists with the group class and the plan.

     • A census member is associated with a valid group class, no ContractGroupPlanGroupClass record exists for the group class, and the plan doesn't exist for any other group class.

     • A census member is not associated with a valid group class and no ContractGroupPlanGroupClass record exists with the plan.

   • A plan is not added to a GroupCensusMemberPlan if:

     • A census member is associated with a valid group class, no ContractGroupPlanGroupClass record exists for the group class, but the plan does exist for another group class.

     • A census member is not associated with a valid group class and a ContractGroupPlanGroupClass record exists with the plan and group classes.

4. When invalid contractGroupPlanIds are passed for a groupCensusMember (the flag isNewMember is true), the service deletes the groupCensusMember records and doesn't create any new GroupCensusMemberPlan records for the groupCensusMember. Expect this output only when the flag onlySaveMembersWithValidProducts is set true in the JSON object.

Remote Options

Service Behavior

Understand how different inputs affect the service outputs.

Input JSON

Here's the format of the input JSON:

{ 
   "censusId":"ID",
   "contractId":"ID",
   "census":{ 
      "headers":[ 
         { 
            "name":"GroupCensusMemberPlan.fieldAPI1"
         },
         { 
            "name":"GroupCensusMemberPlan.fieldAPI2"
         }
      ],
      "members":[ 
         { 
            "Id":"Census Member ID",
            "isNewMember":true,
            "GroupCensusMemberPlan.fieldAPI1":"value1",
            "GroupCensusMemberPlan.fieldAPI2":"value2",
            "ContractGroupPlanId": "ContractGroupPlan.Id;ChildContractGroupPlan.Id"
         },
         { 
            "Id":"Census Member ID",
            "isNewMember":true,
            "GroupCensusMemberPlan.fieldAPI1":"value1",
            "GroupCensusMemberPlan.fieldAPI2":"value2",
            "ContractGroupPlanId": "ContractGroupPlan.Id;ChildContractGroupPlan.Id"
         }
      ]
   },
   "onlySaveMembersWithValidProducts" : true
}

Here's an example of the input JSON:

{ 
   "censusId":"a4D4P000000hbjSUAQ",
   "contractId":"8004P000000zF2dQAE",
   "census":{ 
      "members":[ 
         { 
            "ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ",
            "Id":"a4C4P000000d7POUAY"
         }
      ],
      "headers":[ 
         { 
            "name":"ContractGroupPlanId"
         }
      ]
   }
}

Output JSON

The service returns the list of successfully inserted GroupCensusMemberPlan Ids. It also provides the list of errors encountered. These errors are grouped per member.

Here's the format of the output JSON:

{ 
   "memberPlanIds":[ 
      "GroupCensusMemberPlan.Id"
   ],
   "errors":[ 
      { 
         "error":"error"
      }
   ]
}

The service returns an output JSON, formatted like this:

{ 
   "memberPlanIds":[ 
      "a4B4P000006jKsMUAU",
      "a4B4P000006jKsNUAU",
      "a4B4P000006jKsOUAU",
      "a4B4P000006jKsPUAU"
   ],
   "errors":[ 
      { 
         "numPlansError":2,
         "error":"ContractGroupPlan value is not valid:8004P000000zJKjQAM; Medical",
         "numPlans":2,
         "Id":"a4C4P000000ed6dUAA",
         "isNewMember":true,
         "ContractGroupPlan":"8004P000000zJKjQAM;Medical"
      }
   ]
}