Member COB Savings

Create MemberCOBSavings

Creates a new MemberCOBSavings

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberCOBSavings_Key
required
integer <int32>

Unique identifier for each COB Savings record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coB_Savings
number or null <double>

Allows the User to override the automated COB Savings amount. If the ‘Use COB Savings’ option is selected within ‘Plan Options’, COB Savings auto-populate based upon the ‘COB’ amount.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

group_ID
required
string [ 1 .. 20 ] characters

Group associated with the COB savings override.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

plan_Type
required
string [ 1 .. 6 ] characters

Identifies the plan type that the COB savings override will be applied to.

plan_Year
required
string [ 1 .. 8 ] characters

Identifies the plan year that the COB savings override will be applied to.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

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/subscribers/{subscriberID}/members/{memberSeq}/cob-savings
Request samples
{
  • "memberCOBSavings_Key": 0,
  • "coB_Savings": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "plan_Type": "string",
  • "plan_Year": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberCOBSavings

Lists all MemberCOBSavings for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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}/cob-savings
Request samples 
Response samples 
No sample
Get MemberCOBSavings
Gets MemberCOBSavings


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCOBSavingsKey
required
integer <int32> 
MemberCOBSavings Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/cob-savings/{memberCOBSavingsKey}
Request samples 
Response samples 
No sample
Update MemberCOBSavings
Updates a specific MemberCOBSavings.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCOBSavingsKey
required
integer <int32> 
MemberCOBSavings Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberCOBSavings_Key
required
integer <int32> 
Unique identifier for each COB Savings record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Savings
number or null <double> 
Allows the User to override the automated COB Savings amount. If the ‘Use COB Savings’ option is selected within ‘Plan Options’, COB Savings auto-populate based upon the ‘COB’ amount.


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


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


 
group_ID
required
string  [ 1 .. 20 ] characters 
Group associated with the COB savings override.


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


 
plan_Type
required
string  [ 1 .. 6 ] characters 
Identifies the plan type that the COB savings override will be applied to.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Identifies the plan year that the COB savings override will be applied to.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/members/{memberSeq}/cob-savings/{memberCOBSavingsKey}
Request samples 
{
  • "memberCOBSavings_Key": 0,
  • "coB_Savings": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "plan_Type": "string",
  • "plan_Year": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberCOBSavings
Deletes an MemberCOBSavings


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCOBSavingsKey
required
integer <int32> 
MemberCOBSavings Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/cob-savings/{memberCOBSavingsKey}
Request samples 
Create or Update Batch MemberCOBSavings
Create or Update multiple MemberCOBSavings 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberCOBSavings_Key
required
integer <int32> 
Unique identifier for each COB Savings record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coB_Savings
number or null <double> 
Allows the User to override the automated COB Savings amount. If the ‘Use COB Savings’ option is selected within ‘Plan Options’, COB Savings auto-populate based upon the ‘COB’ amount.


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


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


 
group_ID
required
string  [ 1 .. 20 ] characters 
Group associated with the COB savings override.


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


 
plan_Type
required
string  [ 1 .. 6 ] characters 
Identifies the plan type that the COB savings override will be applied to.


 
plan_Year
required
string  [ 1 .. 8 ] characters 
Identifies the plan year that the COB savings override will be applied to.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/members/{memberSeq}/cob-savings-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}