Capitation Service Plans

Create CapitationServicePlan

Creates a new CapitationServicePlan

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

CapitationService Key

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitationService_Key
required
integer <int32>

ID for the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.

plan_ID
required
string [ 1 .. 20 ] characters

ID of the plan associated with the capitation service.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date 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/capitation-services/{capitationServiceKey}/capitation-service-plans/{planID}
Request samples
{
  • "capitationService_Key": 0,
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get CapitationServicePlan

Gets CapitationServicePlan

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

CapitationService Key

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/capitation-services/{capitationServiceKey}/capitation-service-plans/{planID}
Request samples 
Response samples 
No sample
Update CapitationServicePlan
Updates a specific CapitationServicePlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
capitationService_Key
required
integer <int32> 
ID for the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
ID of the plan associated with the capitation service.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date 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/capitation-services/{capitationServiceKey}/capitation-service-plans/{planID}
Request samples 
{
  • "capitationService_Key": 0,
  • "plan_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CapitationServicePlan
Deletes an CapitationServicePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-services/{capitationServiceKey}/capitation-service-plans/{planID}
Request samples 
List CapitationServicePlan
Lists all CapitationServicePlan for the given capitationServiceKey


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService 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/capitation-services/{capitationServiceKey}/capitation-service-plans
Request samples 
Response samples 
No sample
Create or Update Batch CapitationServicePlan
Create or Update multiple CapitationServicePlan 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
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
capitationService_Key
required
integer <int32> 
ID for the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
ID of the plan associated with the capitation service.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date 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/capitation-services/{capitationServiceKey}/capitation-service-plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}