# Create SubEnrollmentRider Creates a new SubEnrollmentRider Endpoint: POST /subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders Version: v1 Security: apiKeyAuth, bearerAuth ## Header parameters: - `vbasoftware-database` (string, required) Target database ## Path parameters: - `subscriberID` (string, required) Subscriber ID - `groupID` (string, required) Group ID - `divisionID` (string, required) Division ID - `groupCoverageStart` (string, required) Group Coverage Start - `startDate` (string, required) Start Date - `planID` (string, required) Plan ID - `planStart` (string, required) Plan Start ## Request fields (application/json): - `subscriber_ID` (string, required) References the SubenrollmentPlan.Subscriber_ID value in the parent table. - `group_ID` (string, required) References the SubenrollmentPlan.Group_ID value in the parent table. - `division_ID` (string, required) References the SubenrollmentPlan.Division_ID value in the parent table. - `group_Coverage_Start` (string, required) References the SubenrollmentPlan.Group_Coverage_Start value in the parent table. - `start_Date` (string, required) References the SubenrollmentPlan.Start_Date value in the parent table. - `plan_ID` (string, required) References the SubenrollmentPlan.Plan_ID value in the parent table. - `plan_Start` (string, required) References the SubenrollmentPlan.Plan_Start value in the parent table. - `benefit_Code` (string, required) References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in. - `from_Date` (string, required) Start date of Rider coverage. - `billing_Member_Seq_Override` (string,null) By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations. - `employee_Contribution` (number,null) Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts. - `employee_Contribution_Pct` (boolean, required) Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `entry_Date` (string) Date when the record was first added to the system. - `entry_User` (string,null) User that first added the record to the system. - `external_ID` (string,null) Custom value used for Ceridican tax processing interface. - `initial_Volume` (number,null) This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary. - `initial_Volume_Salary_Pct` (boolean, required) Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `ltC_Daily_Benefit_Amount` (number,null) Member elected Daily Benefit Amount - `ltC_Lifetime_Max_Amount` (number,null) Lifetime Max Amount elected - `ltC_Lifetime_Max_Days` (integer,null) Lifetime Max Days elected - `ltC_Lifetime_Max_Years` (integer,null) Lifetime Max Years elected - `ltC_Monthly_Benefit_Amount` (number,null) Member elected Monthly Benefit Amount - `new_CommissionAgencyRep_Key` (integer,null) No longer in use. - `original_CommissionAgencyRep_Key` (integer,null) No longer in use. - `thru_Date` (string,null) End date of Rider coverage. - `update_Date` (string) Date when the record was last updated in the system. - `update_User` (string,null) User that last updated the record in the system. - `use_Employee_Age` (boolean, required) Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `use_GI_Volume_Min_Max` (boolean, required) The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `use_Volume_Scale` (boolean, required) This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `volume` (number,null) The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing. ## Response 200 fields (text/plain): - `data` (object) - `data.subscriber_ID` (string, required) References the SubenrollmentPlan.Subscriber_ID value in the parent table. - `data.group_ID` (string, required) References the SubenrollmentPlan.Group_ID value in the parent table. - `data.division_ID` (string, required) References the SubenrollmentPlan.Division_ID value in the parent table. - `data.group_Coverage_Start` (string, required) References the SubenrollmentPlan.Group_Coverage_Start value in the parent table. - `data.start_Date` (string, required) References the SubenrollmentPlan.Start_Date value in the parent table. - `data.plan_ID` (string, required) References the SubenrollmentPlan.Plan_ID value in the parent table. - `data.plan_Start` (string, required) References the SubenrollmentPlan.Plan_Start value in the parent table. - `data.benefit_Code` (string, required) References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in. - `data.from_Date` (string, required) Start date of Rider coverage. - `data.billing_Member_Seq_Override` (string,null) By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations. - `data.employee_Contribution` (number,null) Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts. - `data.employee_Contribution_Pct` (boolean, required) Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `data.entry_Date` (string) Date when the record was first added to the system. - `data.entry_User` (string,null) User that first added the record to the system. - `data.external_ID` (string,null) Custom value used for Ceridican tax processing interface. - `data.initial_Volume` (number,null) This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary. - `data.initial_Volume_Salary_Pct` (boolean, required) Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `data.ltC_Daily_Benefit_Amount` (number,null) Member elected Daily Benefit Amount - `data.ltC_Lifetime_Max_Amount` (number,null) Lifetime Max Amount elected - `data.ltC_Lifetime_Max_Days` (integer,null) Lifetime Max Days elected - `data.ltC_Lifetime_Max_Years` (integer,null) Lifetime Max Years elected - `data.ltC_Monthly_Benefit_Amount` (number,null) Member elected Monthly Benefit Amount - `data.new_CommissionAgencyRep_Key` (integer,null) No longer in use. - `data.original_CommissionAgencyRep_Key` (integer,null) No longer in use. - `data.thru_Date` (string,null) End date of Rider coverage. - `data.update_Date` (string) Date when the record was last updated in the system. - `data.update_User` (string,null) User that last updated the record in the system. - `data.use_Employee_Age` (boolean, required) Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `data.use_GI_Volume_Min_Max` (boolean, required) The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `data.use_Volume_Scale` (boolean, required) This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `data.volume` (number,null) The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing. - `error` (object) - `error.detail` (string,null) A human-readable explanation specific to this occurrence of the problem. - `error.instance` (string,null) A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced. - `error.status` (integer) The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. - `error.title` (string,null) A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4). - `error.type` (string,null) A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". - `debug` (object) - `debug.activityID` (string, required) ## Response 401 fields