Member Insurance

Create MemberInsurance

Creates a new MemberInsurance

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
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

seq_Number
required
integer <int32>

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

carrier_Key
integer or null <int32>

Identifies the 'Other Insurance' Carrier.

carrier_Name
string or null <= 64 characters

Carrier name for this other insurance record.

coverageType
string or null <= 20 characters

Coverage Type of 'Other Insurance' policy.

end_Date
string or null <date-time>

Date when the 'Other Insurance' expires/expired.

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_Number
string or null <= 20 characters

Group number of 'Other Insurance' policy.

insurance_Type
integer or null <int32>

Insurance type of the 'Other Insurance' policy.

limits
number or null <double>

Dollar amount of the 'Other Insurance' policy.

plan_Type
string or null <= 6 characters

Plan type associated with the 'Other Insurance'.

policyHolderName
string or null <= 40 characters

Name of the 'Other Insurance' primary policy holder.

policy_Number
string or null <= 32 characters

Number of the 'Other Insurance' policy.

priority
required
integer <int32>

Priority of the Member's 'Other Insurance'. Note: This field is marked as NOT NULL in the database and therefore required by the API.

secondary_Member_Seq
string or null <= 2 characters

For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.

secondary_Subscriber_ID
string or null <= 9 characters

For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.

start_Date
string or null <date-time>

Date when the 'Other Insurance' becomes/became effective.

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}/insurances
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "seq_Number": 0,
  • "carrier_Key": 0,
  • "carrier_Name": "string",
  • "coverageType": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Number": "string",
  • "insurance_Type": 0,
  • "limits": 0.1,
  • "plan_Type": "string",
  • "policyHolderName": "string",
  • "policy_Number": "string",
  • "priority": 0,
  • "secondary_Member_Seq": "st",
  • "secondary_Subscriber_ID": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberInsurance

Lists all MemberInsurance 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}/insurances
Request samples 
Response samples 
No sample
Get MemberInsurance
Gets MemberInsurance


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
seqNumber
required
integer <int32> 
Seq Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/insurances/{seqNumber}
Request samples 
Response samples 
No sample
Update MemberInsurance
Updates a specific MemberInsurance.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
seqNumber
required
integer <int32> 
Seq Number


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
seq_Number
required
integer <int32> 
Unique sequence value for each Insurance record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
carrier_Key
integer or null <int32> 
Identifies the 'Other Insurance' Carrier.


 
carrier_Name
string or null  <= 64 characters 
Carrier name for this other insurance record.


 
coverageType
string or null  <= 20 characters 
Coverage Type of 'Other Insurance' policy.


 
end_Date
string or null <date-time> 
Date when the 'Other Insurance' expires/expired.


 
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_Number
string or null  <= 20 characters 
Group number of 'Other Insurance' policy.


 
insurance_Type
integer or null <int32> 
Insurance type of the 'Other Insurance' policy.


 
limits
number or null <double> 
Dollar amount of the 'Other Insurance' policy.


 
plan_Type
string or null  <= 6 characters 
Plan type associated with the 'Other Insurance'.


 
policyHolderName
string or null  <= 40 characters 
Name of the 'Other Insurance' primary policy holder.


 
policy_Number
string or null  <= 32 characters 
Number of the 'Other Insurance' policy.


 
priority
required
integer <int32> 
Priority of the Member's 'Other Insurance'. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
secondary_Member_Seq
string or null  <= 2 characters 
For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.


 
secondary_Subscriber_ID
string or null  <= 9 characters 
For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.


 
start_Date
string or null <date-time> 
Date when the 'Other Insurance' becomes/became effective.


 
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}/insurances/{seqNumber}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "seq_Number": 0,
  • "carrier_Key": 0,
  • "carrier_Name": "string",
  • "coverageType": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_Number": "string",
  • "insurance_Type": 0,
  • "limits": 0.1,
  • "plan_Type": "string",
  • "policyHolderName": "string",
  • "policy_Number": "string",
  • "priority": 0,
  • "secondary_Member_Seq": "st",
  • "secondary_Subscriber_ID": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberInsurance
Deletes an MemberInsurance


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
seqNumber
required
integer <int32> 
Seq Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/insurances/{seqNumber}
Request samples 
Create or Update Batch MemberInsurance
Create or Update multiple MemberInsurance 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 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


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


 
seq_Number
required
integer <int32> 
Unique sequence value for each Insurance record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
carrier_Key
integer or null <int32> 
Identifies the 'Other Insurance' Carrier.


 
carrier_Name
string or null  <= 64 characters 
Carrier name for this other insurance record.


 
coverageType
string or null  <= 20 characters 
Coverage Type of 'Other Insurance' policy.


 
end_Date
string or null <date-time> 
Date when the 'Other Insurance' expires/expired.


 
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_Number
string or null  <= 20 characters 
Group number of 'Other Insurance' policy.


 
insurance_Type
integer or null <int32> 
Insurance type of the 'Other Insurance' policy.


 
limits
number or null <double> 
Dollar amount of the 'Other Insurance' policy.


 
plan_Type
string or null  <= 6 characters 
Plan type associated with the 'Other Insurance'.


 
policyHolderName
string or null  <= 40 characters 
Name of the 'Other Insurance' primary policy holder.


 
policy_Number
string or null  <= 32 characters 
Number of the 'Other Insurance' policy.


 
priority
required
integer <int32> 
Priority of the Member's 'Other Insurance'. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
secondary_Member_Seq
string or null  <= 2 characters 
For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.


 
secondary_Subscriber_ID
string or null  <= 9 characters 
For purposes of utlizing Auto-COB processing, this indicates the member who is covered by Secondary Insurance under this Insured record.


 
start_Date
string or null <date-time> 
Date when the 'Other Insurance' becomes/became effective.


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