Care Plans

Create CarePlan

Creates a new CarePlan

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlan_Key
required
integer <int32>
care_Type
string or null <= 32 characters
care_Weight
number or null <double>
description
string or null <= 512 characters
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-plans
Request samples
{
  • "carePlan_Key": 0,
  • "care_Type": "string",
  • "care_Weight": 0.1,
  • "description": "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": {
    }
}

List CarePlan

Lists all CarePlan

SecurityapiKeyAuth and bearerAuth
Request
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-plans
Request samples 
Response samples 
No sample
Get CarePlan
Gets CarePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}
Request samples 
Response samples 
No sample
Update CarePlan
Updates a specific CarePlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carePlan_Key
required
integer <int32> 
 
care_Type
string or null  <= 32 characters 
 
care_Weight
number or null <double> 
 
description
string or null  <= 512 characters 
 
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


put/care-plans/{carePlanKey}
Request samples 
{
  • "carePlan_Key": 0,
  • "care_Type": "string",
  • "care_Weight": 0.1,
  • "description": "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 CarePlan
Deletes an CarePlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}
Request samples 
Create or Update Batch CarePlan
Create or Update multiple CarePlan at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
carePlan_Key
required
integer <int32> 
 
care_Type
string or null  <= 32 characters 
 
care_Weight
number or null <double> 
 
description
string or null  <= 512 characters 
 
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-plans-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}