Care Plan Custom Values

Create CarePlanCustomValue

Creates a new CarePlanCustomValue

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

CarePlan Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlanCustomValue_Key
required
integer <int32>
carePlan_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
iD_Code
required
string [ 1 .. 16 ] characters
required
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-plans/{carePlanKey}/custom-values
Request samples
{
  • "carePlanCustomValue_Key": 0,
  • "carePlan_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iD_Code": "string",
  • "required": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CarePlanCustomValue

Lists all CarePlanCustomValue for the given carePlanKey

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

CarePlan 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-plans/{carePlanKey}/custom-values
Request samples 
Response samples 
No sample
Get CarePlanCustomValue
Gets CarePlanCustomValue


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


 
carePlanCustomValueKey
required
integer <int32> 
CarePlanCustomValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}/custom-values/{carePlanCustomValueKey}
Request samples 
Response samples 
No sample
Update CarePlanCustomValue
Updates a specific CarePlanCustomValue.


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


 
carePlanCustomValueKey
required
integer <int32> 
CarePlanCustomValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carePlanCustomValue_Key
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
iD_Code
required
string  [ 1 .. 16 ] characters 
 
required
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/care-plans/{carePlanKey}/custom-values/{carePlanCustomValueKey}
Request samples 
{
  • "carePlanCustomValue_Key": 0,
  • "carePlan_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iD_Code": "string",
  • "required": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CarePlanCustomValue
Deletes an CarePlanCustomValue


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


 
carePlanCustomValueKey
required
integer <int32> 
CarePlanCustomValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/custom-values/{carePlanCustomValueKey}
Request samples 
Create or Update Batch CarePlanCustomValue
Create or Update multiple CarePlanCustomValue 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
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
carePlanCustomValue_Key
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
iD_Code
required
string  [ 1 .. 16 ] characters 
 
required
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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