Care Case Providers

Create CareCaseProvider

Creates a new CareCaseProvider

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseProvider_Key
required
integer <int32>
case_Key
required
integer <int32>
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
provider_ID
string or null <= 20 characters
provider_Role_ID
string or null <= 20 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/providers
Request samples
{
  • "careCaseProvider_Key": 0,
  • "case_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "provider_Role_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseProvider

Lists all CareCaseProvider 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}/providers
Request samples 
Response samples 
No sample
Get CareCaseProvider
Gets CareCaseProvider


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


 
careCaseProviderKey
required
integer <int32> 
CareCaseProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/providers/{careCaseProviderKey}
Request samples 
Response samples 
No sample
Update CareCaseProvider
Updates a specific CareCaseProvider.


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


 
careCaseProviderKey
required
integer <int32> 
CareCaseProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseProvider_Key
required
integer <int32> 
 
case_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
provider_ID
string or null  <= 20 characters 
 
provider_Role_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/providers/{careCaseProviderKey}
Request samples 
{
  • "careCaseProvider_Key": 0,
  • "case_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "provider_Role_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseProvider
Deletes an CareCaseProvider


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


 
careCaseProviderKey
required
integer <int32> 
CareCaseProvider Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/providers/{careCaseProviderKey}
Request samples 
Create or Update Batch CareCaseProvider
Create or Update multiple CareCaseProvider 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 
careCaseProvider_Key
required
integer <int32> 
 
case_Key
required
integer <int32> 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
provider_ID
string or null  <= 20 characters 
 
provider_Role_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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