Care Case Intakes

Create CareCaseIntake

Creates a new CareCaseIntake

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseIntake_Key
required
integer <int32>
careCaseIntakeSecondaryType_ID
string or null
careCaseIntakeType_ID
string or null
case_Key
integer or null <int32>
comment
string or null
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
log_Date
string or null <date-time>
log_User_ID
string or null <= 64 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/intakes
Request samples
{
  • "careCaseIntake_Key": 0,
  • "careCaseIntakeSecondaryType_ID": "string",
  • "careCaseIntakeType_ID": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "log_User_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseIntake

Lists all CareCaseIntake for the given caseKey

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

Case 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/cases/{caseKey}/intakes
Request samples 
Response samples 
No sample
Get CareCaseIntake
Gets CareCaseIntake


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseIntakeKey
required
integer <int32> 
CareCaseIntake Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/intakes/{careCaseIntakeKey}
Request samples 
Response samples 
No sample
Update CareCaseIntake
Updates a specific CareCaseIntake.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseIntakeKey
required
integer <int32> 
CareCaseIntake Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseIntake_Key
required
integer <int32> 
 
careCaseIntakeSecondaryType_ID
string or null
 
careCaseIntakeType_ID
string or null
 
case_Key
integer or null <int32> 
 
comment
string or null
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
log_Date
string or null <date-time> 
 
log_User_ID
string or null  <= 64 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/intakes/{careCaseIntakeKey}
Request samples 
{
  • "careCaseIntake_Key": 0,
  • "careCaseIntakeSecondaryType_ID": "string",
  • "careCaseIntakeType_ID": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "log_User_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseIntake
Deletes an CareCaseIntake


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseIntakeKey
required
integer <int32> 
CareCaseIntake Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/intakes/{careCaseIntakeKey}
Request samples 
Create or Update Batch CareCaseIntake
Create or Update multiple CareCaseIntake 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
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
careCaseIntake_Key
required
integer <int32> 
 
careCaseIntakeSecondaryType_ID
string or null
 
careCaseIntakeType_ID
string or null
 
case_Key
integer or null <int32> 
 
comment
string or null
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
log_Date
string or null <date-time> 
 
log_User_ID
string or null  <= 64 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/cases/{caseKey}/intakes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}