Plan Displays

Create PlanDisplay

Creates a new PlanDisplay

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planDisplay_Key
required
integer <int32>

Unique identifier for each Plan Display value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

display
string or null <= 512 characters

Allows the User to input text that will be tied to the chosen display type and can be exported to the User's designated ID card printer.

display_Type
required
string [ 1 .. 32 ] characters

Allows the User to choose which type of display they would like to add text for. These display types are defined from 'Display Types' within Plan Benefit Configuration.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID value in parent table.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/displays
Request samples
{
  • "planDisplay_Key": 0,
  • "display": "string",
  • "display_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanDisplay

Lists all PlanDisplay

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/displays
Request samples 
Response samples 
No sample
Get PlanDisplay
Gets PlanDisplay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDisplayKey
required
integer <int32> 
PlanDisplay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/displays/{planDisplayKey}
Request samples 
Response samples 
No sample
Update PlanDisplay
Updates a specific PlanDisplay.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDisplayKey
required
integer <int32> 
PlanDisplay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planDisplay_Key
required
integer <int32> 
Unique identifier for each Plan Display value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
display
string or null  <= 512 characters 
Allows the User to input text that will be tied to the chosen display type and can be exported to the User's designated ID card printer.


 
display_Type
required
string  [ 1 .. 32 ] characters 
Allows the User to choose which type of display they would like to add text for. These display types are defined from 'Display Types' within Plan Benefit Configuration.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/displays/{planDisplayKey}
Request samples 
{
  • "planDisplay_Key": 0,
  • "display": "string",
  • "display_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanDisplay
Deletes an PlanDisplay


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDisplayKey
required
integer <int32> 
PlanDisplay Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/displays/{planDisplayKey}
Request samples 
Create or Update Batch PlanDisplay
Create or Update multiple PlanDisplay at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
planDisplay_Key
required
integer <int32> 
Unique identifier for each Plan Display value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
display
string or null  <= 512 characters 
Allows the User to input text that will be tied to the chosen display type and can be exported to the User's designated ID card printer.


 
display_Type
required
string  [ 1 .. 32 ] characters 
Allows the User to choose which type of display they would like to add text for. These display types are defined from 'Display Types' within Plan Benefit Configuration.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/displays-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}