APIs for VBASoftware
/
Delete PlanType
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
Unique identifier for each plan type that Identifies the Type of Plan (medical, dental, etc.).
Indicates whether the associated plan should be capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Dental Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
A description area used to provider more detail about the plan type.
Indicates whether the specified plan type is associated with a Discount Fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a associated with a discount card. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a HRA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a HSA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Shortened description of the plan type that is used to print on ID cards.
Indicates whether the specified plan type is an Indemnity Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this plan type is a LTC plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Long-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Life/ADD Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Medical Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this plan type is a Pension plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Pharmacy Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type should be printed on ID cards. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Short-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Section 125 Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This flag indicates Tier is a required field when updating an enrollment Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plan-types/{planType}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/plan-types/{planType}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"plan_Type": "string",
"capitated": true,
"claims": true,
"dental": true,
"description": "string",
"disc_Fee": true,
"discountCard": true,
"encounters": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hipaA_Code": "string",
"hra": true,
"hsa": true,
"iD_Card_Description": "string",
"indemnity": true,
"ltc": true,
"ltd": true,
"lifeADD": true,
"medical": true,
"misc": true,
"pay_As_You_Go": true,
"pension": true,
"pharmacy": true,
"print_On_ID": true,
"std": true,
"section125": true,
"tier_Required": true,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"vision": true
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plan-types/{planType}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/plan-types/{planType}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
Unique identifier for each plan type that Identifies the Type of Plan (medical, dental, etc.).
Indicates whether the associated plan should be capitated. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Dental Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
A description area used to provider more detail about the plan type.
Indicates whether the specified plan type is associated with a Discount Fee. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a associated with a discount card. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a HRA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a HSA Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Shortened description of the plan type that is used to print on ID cards.
Indicates whether the specified plan type is an Indemnity Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this plan type is a LTC plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Long-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Life/ADD Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Medical Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates if this plan type is a Pension plan type. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Pharmacy Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type should be printed on ID cards. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Short-Term Disability Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Section 125 Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
This flag indicates Tier is a required field when updating an enrollment Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates whether the specified plan type is a Vision Plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/plan-types-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/plan-types-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"plan_Type": "string",
"capitated": true,
"claims": true,
"dental": true,
"description": "string",
"disc_Fee": true,
"discountCard": true,
"encounters": true,
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"hipaA_Code": "string",
"hra": true,
"hsa": true,
"iD_Card_Description": "string",
"indemnity": true,
"ltc": true,
"ltd": true,
"lifeADD": true,
"medical": true,
"misc": true,
"pay_As_You_Go": true,
"pension": true,
"pharmacy": true,
"print_On_ID": true,
"std": true,
"section125": true,
"tier_Required": true,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"vision": true
}
]'Response
No response example