Member Beneficiary Plans

Create MemberBeneficiaryPlan

Creates a new MemberBeneficiaryPlan

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

beneficiaryID
required
string

Beneficiary ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References MemberBeneficiary.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References MemberBeneficiary.Member_Seq value on the parent record.

beneficiary_ID
required
string [ 1 .. 20 ] characters

References MemberBeneficiary.Beneficiary_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

References Plans.Plan_ID value on parent record.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date 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/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "beneficiary_ID": "string",
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberBeneficiaryPlan

Lists all MemberBeneficiaryPlan for the given subscriberID and memberSeq and beneficiaryID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

beneficiaryID
required
string

Beneficiary ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans
Request samples 
Response samples 
No sample
Get MemberBeneficiaryPlan
Gets MemberBeneficiaryPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans/{planID}
Request samples 
Response samples 
No sample
Update MemberBeneficiaryPlan
Updates a specific MemberBeneficiaryPlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References MemberBeneficiary.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References MemberBeneficiary.Member_Seq value on the parent record.


 
beneficiary_ID
required
string  [ 1 .. 20 ] characters 
References MemberBeneficiary.Beneficiary_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID value on parent record.


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


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


 
update_Date
string <date-time> 
Date 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/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans/{planID}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "beneficiary_ID": "string",
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberBeneficiaryPlan
Deletes an MemberBeneficiaryPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans/{planID}
Request samples 
Create or Update Batch MemberBeneficiaryPlan
Create or Update multiple MemberBeneficiaryPlan 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
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References MemberBeneficiary.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References MemberBeneficiary.Member_Seq value on the parent record.


 
beneficiary_ID
required
string  [ 1 .. 20 ] characters 
References MemberBeneficiary.Beneficiary_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References Plans.Plan_ID value on parent record.


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


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


 
update_Date
string <date-time> 
Date 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/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}/plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}