Subscriber Plan Policy Statuses

Create SubscriberPolicyStatus

Creates a new SubscriberPolicyStatus

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

policyNumber
required
string

Policy Number

header Parameters
vbasoftware-database
required
string

Target database

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

References Subscribers.Subscriber_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the plan.

benefit_Code
required
string [ 1 .. 10 ] characters

Benefit code associated with the selected plan.

policy_Number
required
string [ 1 .. 64 ] characters

Policy number of the associated plan.

policy_Status
required
string [ 1 .. 32 ] characters

Indicates the status of the policy (active, inactive, etc.).

effective_Date
required
string <date-time>

Date when the policy status goes/went into effect. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

term_Date
string or null <date-time>

Date when the policy status 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}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses
Request samples
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "policy_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberPolicyStatus

Lists all SubscriberPolicyStatus for the given subscriberID and planID and benefitCode and policyNumber

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

policyNumber
required
string

Policy Number

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}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses
Request samples 
Response samples 
No sample
Get SubscriberPolicyStatus
Gets SubscriberPolicyStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
policyStatus
required
string
Policy Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses/{policyStatus}
Request samples 
Response samples 
No sample
Update SubscriberPolicyStatus
Updates a specific SubscriberPolicyStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
policyStatus
required
string
Policy Status


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit code associated with the selected plan.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the associated plan.


 
policy_Status
required
string  [ 1 .. 32 ] characters 
Indicates the status of the policy (active, inactive, etc.).


 
effective_Date
required
string <date-time> 
Date when the policy status goes/went into effect. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
term_Date
string or null <date-time> 
Date when the policy status 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}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses/{policyStatus}
Request samples 
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "policy_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberPolicyStatus
Deletes an SubscriberPolicyStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
policyStatus
required
string
Policy Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses/{policyStatus}
Request samples 
Create or Update Batch SubscriberPolicyStatus
Create or Update multiple SubscriberPolicyStatus 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


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit code associated with the selected plan.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the associated plan.


 
policy_Status
required
string  [ 1 .. 32 ] characters 
Indicates the status of the policy (active, inactive, etc.).


 
effective_Date
required
string <date-time> 
Date when the policy status goes/went into effect. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
term_Date
string or null <date-time> 
Date when the policy status 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}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/statuses-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}