Care Case Savings

Create CareCaseSavings

Creates a new CareCaseSavings

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseSavings_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
parent_WorkLog_Type
string or null <= 32 characters
savings_Amount
number or null <double>
savings_Type
string or null <= 20 characters
secondarySavings_Type
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}/savings
Request samples
{
  • "careCaseSavings_Key": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parent_WorkLog_Type": "string",
  • "savings_Amount": 0.1,
  • "savings_Type": "string",
  • "secondarySavings_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseSavings

Lists all CareCaseSavings 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}/savings
Request samples
Response samples
No sample

Get CareCaseSavings

Gets CareCaseSavings

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

Case Key

careCaseSavingsKey
required
integer <int32>

CareCaseSavings Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/cases/{caseKey}/savings/{careCaseSavingsKey}
Request samples
Response samples
No sample

Update CareCaseSavings

Updates a specific CareCaseSavings.

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

Case Key

careCaseSavingsKey
required
integer <int32>

CareCaseSavings Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseSavings_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
parent_WorkLog_Type
string or null <= 32 characters
savings_Amount
number or null <double>
savings_Type
string or null <= 20 characters
secondarySavings_Type
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}/savings/{careCaseSavingsKey}
Request samples
{
  • "careCaseSavings_Key": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "parent_WorkLog_Type": "string",
  • "savings_Amount": 0.1,
  • "savings_Type": "string",
  • "secondarySavings_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete CareCaseSavings

Deletes an CareCaseSavings

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

Case Key

careCaseSavingsKey
required
integer <int32>

CareCaseSavings Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/cases/{caseKey}/savings/{careCaseSavingsKey}
Request samples

Create or Update Batch CareCaseSavings

Create or Update multiple CareCaseSavings 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
careCaseSavings_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
parent_WorkLog_Type
string or null <= 32 characters
savings_Amount
number or null <double>
savings_Type
string or null <= 20 characters
secondarySavings_Type
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}/savings-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}