API InsPlans

See API Specification

InsPlans GET

Version Added: 22.3.30

Gets a list of InsPlans.

Example Request:
GET /insplans

Example Response:
[
{
"PlanNum": 6,
"GroupName": "United States Post Office",
"GroupNum": "PB181863",
"PlanNote": "Mostly covered.",
"FeeSched": 54,
"PlanType": "p",
"MonthRenew": 0
},
{
"PlanNum": 14,
"GroupName": "REI",
"GroupNum": "G189614",
"PlanNote": "",
"FeeSched": 0,
"PlanType": "c",
"MonthRenew": 6
},
etc...
]

200 OK

InsPlans PUT

Version Added: 22.3.30

Updates an InsPlan.

PlanNum: Required in the URL.
GroupName: Optional. Typically the same as the employer. Used to identify difference in plans.
GroupNum: Optional. The Plan Number in Canada.
PlanNote: Optional. Note for this plan. Same for all subscribers.
FeeSched: Optional. FK to feesched.FeeSchedNum.
PlanType: Optional. Must be one of the following: "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation).
MonthRenew: Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Use 0 to indicate calendar year.

Example Requests:
PUT /insplans/15

{
"FeeSched": 0,
"PlanType": "",
"MonthRenew": 0
}

or

{
"GroupName": "Pixar",
"GroupNum": "Y4845",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"MonthRenew": 12
}

Example Response:
{
"PlanNum": 15,
"GroupName": "Pixar",
"GroupNum": "Y4845",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"MonthRenew": 12
}

200 OK
400 BadRequest (Invalid fields)
404 NotFound ("InsPlan not found" or "FeeSched not found")