Premium Rate Members

Create PremRateMember

Creates a new PremRateMember

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Key
required
integer <int32>
subscriber_ID
required
string [ 1 .. 9 ] characters
member_Seq
required
string [ 1 .. 2 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
rate_Override
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-rates/{premRateKey}/members
Request samples
{
  • "premRate_Key": 0,
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "rate_Override": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremRateMember

Lists all PremRateMember for the given premRateKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

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/premium-rates/{premRateKey}/members
Request samples
Response samples
No sample

Get PremRateMember

Gets PremRateMember

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

effectiveDate
required
string <date-time>

Effective Date

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/premium-rates/{premRateKey}/members/{subscriberID}/{memberSeq}/{effectiveDate}
Request samples
Response samples
No sample

Update PremRateMember

Updates a specific PremRateMember.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

effectiveDate
required
string <date-time>

Effective Date

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Key
required
integer <int32>
subscriber_ID
required
string [ 1 .. 9 ] characters
member_Seq
required
string [ 1 .. 2 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
rate_Override
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/premium-rates/{premRateKey}/members/{subscriberID}/{memberSeq}/{effectiveDate}
Request samples
{
  • "premRate_Key": 0,
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "rate_Override": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete PremRateMember

Deletes an PremRateMember

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

effectiveDate
required
string <date-time>

Effective Date

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/premium-rates/{premRateKey}/members/{subscriberID}/{memberSeq}/{effectiveDate}
Request samples

Create or Update Batch PremRateMember

Create or Update multiple PremRateMember 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
premRateKey
required
integer <int32>

PremRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
premRate_Key
required
integer <int32>
subscriber_ID
required
string [ 1 .. 9 ] characters
member_Seq
required
string [ 1 .. 2 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
rate_Override
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/premium-rates/{premRateKey}/members-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}