Care Manager Care Plans

Create CareManagerCarePlan

Creates a new CareManagerCarePlan

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

CareManager Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careManager_Key
required
integer <int32>
carePlan_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-managers/{careManagerKey}/care-plans
Request samples
{
  • "careManager_Key": 0,
  • "carePlan_Key": 0,
  • "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": {
    }
}

List CareManagerCarePlan

Lists all CareManagerCarePlan for the given careManagerKey

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

CareManager 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/care-managers/{careManagerKey}/care-plans
Request samples 
Response samples 
No sample
Get CareManagerCarePlan
Gets CareManagerCarePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
careManagerKey
required
integer <int32> 
CareManager Key


 
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-managers/{careManagerKey}/care-plans/{carePlanKey}
Request samples 
Response samples 
No sample
Delete CareManagerCarePlan
Deletes an CareManagerCarePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
careManagerKey
required
integer <int32> 
CareManager Key


 
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-managers/{careManagerKey}/care-plans/{carePlanKey}
Request samples 
Create or Update Batch CareManagerCarePlan
Create or Update multiple CareManagerCarePlan 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
careManagerKey
required
integer <int32> 
CareManager Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
careManager_Key
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/care-managers/{careManagerKey}/care-plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}