Subscriber Waive Premiums

Create SubscriberWaivePremium

Creates a new SubscriberWaivePremium

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriberWaivePremium_Key
required
integer <int32>

Unique identifier for this waived preimum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

References BenefitCodes.Benefit_Code value on parent record.

effective_Date
string or null <date-time>

Date when the waiver becomes/became effective.

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.

ex_Code
string or null <= 6 characters

Specifies the Ex Code that is to be applied with the waiver.

plan_ID
string or null <= 20 characters

References Plans.Plan_ID value on parent record.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

term_Date
string or null <date-time>

Date when the waiver expires/expired.

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}/waive-premiums
Request samples
{
  • "subscriberWaivePremium_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberWaivePremium

Lists all SubscriberWaivePremium for the given subscriberID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber 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}/waive-premiums
Request samples 
Response samples 
No sample
Get SubscriberWaivePremium
Gets SubscriberWaivePremium


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberWaivePremiumKey
required
integer <int32> 
SubscriberWaivePremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/waive-premiums/{subscriberWaivePremiumKey}
Request samples 
Response samples 
No sample
Update SubscriberWaivePremium
Updates a specific SubscriberWaivePremium.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberWaivePremiumKey
required
integer <int32> 
SubscriberWaivePremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriberWaivePremium_Key
required
integer <int32> 
Unique identifier for this waived preimum. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
References BenefitCodes.Benefit_Code value on parent record.


 
effective_Date
string or null <date-time> 
Date when the waiver becomes/became effective.


 
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.


 
ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that is to be applied with the waiver.


 
plan_ID
string or null  <= 20 characters 
References Plans.Plan_ID value on parent record.


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


 
term_Date
string or null <date-time> 
Date when the waiver expires/expired.


 
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}/waive-premiums/{subscriberWaivePremiumKey}
Request samples 
{
  • "subscriberWaivePremium_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberWaivePremium
Deletes an SubscriberWaivePremium


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subscriberWaivePremiumKey
required
integer <int32> 
SubscriberWaivePremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/waive-premiums/{subscriberWaivePremiumKey}
Request samples 
Create or Update Batch SubscriberWaivePremium
Create or Update multiple SubscriberWaivePremium 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriberWaivePremium_Key
required
integer <int32> 
Unique identifier for this waived preimum. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
References BenefitCodes.Benefit_Code value on parent record.


 
effective_Date
string or null <date-time> 
Date when the waiver becomes/became effective.


 
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.


 
ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that is to be applied with the waiver.


 
plan_ID
string or null  <= 20 characters 
References Plans.Plan_ID value on parent record.


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


 
term_Date
string or null <date-time> 
Date when the waiver expires/expired.


 
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}/waive-premiums-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}