Member Providers

Create MemberProvider

Creates a new MemberProvider

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
memberProvider_Key
required
integer <int32>

Unique identifier for each PCP record attached to this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

capitation_Category
string or null <= 8 characters

Specifies the capitation category.

effective_Date
required
string <date-time>

Date when the Provider became the Member's PCP. Note: This field is marked as NOT NULL in the database and therefore required by the API.

end_Date
string or null <date-time>

Date when the Member left the Provider as their PCP.

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.

ipA_Number
string or null <= 16 characters

Information field used for custom reporting and interfaces.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

provider_ID
required
string [ 1 .. 20 ] characters

Provider designated this Member's PCP.

reason_Code
integer or null <int32>

Specifies the reason for the Member leaving the Provider as their PCP.

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}/providers
Request samples
{
  • "memberProvider_Key": 0,
  • "capitation_Category": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ipA_Number": "string",
  • "member_Seq": "st",
  • "provider_ID": "string",
  • "reason_Code": 0,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberProvider

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}
Request samples 
Response samples 
No sample
Update MemberProvider
Updates a specific MemberProvider.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberProvider_Key
required
integer <int32> 
Unique identifier for each PCP record attached to this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
capitation_Category
string or null  <= 8 characters 
Specifies the capitation category.


 
effective_Date
required
string <date-time> 
Date when the Provider became the Member's PCP. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Date
string or null <date-time> 
Date when the Member left the Provider as their PCP.


 
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.


 
ipA_Number
string or null  <= 16 characters 
Information field used for custom reporting and interfaces.


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


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Provider designated this Member's PCP.


 
reason_Code
integer or null <int32> 
Specifies the reason for the Member leaving the Provider as their PCP.


 
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}/providers/{memberProviderKey}
Request samples 
{
  • "memberProvider_Key": 0,
  • "capitation_Category": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ipA_Number": "string",
  • "member_Seq": "st",
  • "provider_ID": "string",
  • "reason_Code": 0,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberProvider
Deletes an MemberProvider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberProviderKey
required
integer <int32> 
MemberProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/providers/{memberProviderKey}
Request samples 
Create or Update Batch MemberProvider
Create or Update multiple MemberProvider 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 
memberProvider_Key
required
integer <int32> 
Unique identifier for each PCP record attached to this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
capitation_Category
string or null  <= 8 characters 
Specifies the capitation category.


 
effective_Date
required
string <date-time> 
Date when the Provider became the Member's PCP. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
end_Date
string or null <date-time> 
Date when the Member left the Provider as their PCP.


 
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.


 
ipA_Number
string or null  <= 16 characters 
Information field used for custom reporting and interfaces.


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


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Provider designated this Member's PCP.


 
reason_Code
integer or null <int32> 
Specifies the reason for the Member leaving the Provider as their PCP.


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