Claim Rules

Create ClaimRule

Creates a new ClaimRule

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimRule_Key
required
integer <int32>
claimRule_Object
string or null <= 64 characters
claimRule_Result
string or null <= 1 characters
debug
required
boolean
description
string or null <= 512 characters
display
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
error_Code
string or null <= 8 characters
error_Type
string or null <= 32 characters
ex_Code
string or null <= 6 characters
process_If_Error
required
boolean
process_If_Override
required
boolean
required
required
boolean
system_Rule
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-rules
Request samples
{
  • "claimRule_Key": 0,
  • "claimRule_Object": "string",
  • "claimRule_Result": "s",
  • "debug": true,
  • "description": "string",
  • "display": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "error_Code": "string",
  • "error_Type": "string",
  • "ex_Code": "string",
  • "process_If_Error": true,
  • "process_If_Override": true,
  • "required": true,
  • "system_Rule": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimRule

Lists all ClaimRule

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/claim-rules
Request samples 
Response samples 
No sample
Get ClaimRule
Gets ClaimRule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-rules/{claimRuleKey}
Request samples 
Response samples 
No sample
Update ClaimRule
Updates a specific ClaimRule.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimRule_Key
required
integer <int32> 
 
claimRule_Object
string or null  <= 64 characters 
 
claimRule_Result
string or null  <= 1 characters 
 
debug
required
boolean
 
description
string or null  <= 512 characters 
 
display
string or null  <= 64 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
error_Code
string or null  <= 8 characters 
 
error_Type
string or null  <= 32 characters 
 
ex_Code
string or null  <= 6 characters 
 
process_If_Error
required
boolean
 
process_If_Override
required
boolean
 
required
required
boolean
 
system_Rule
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/claim-rules/{claimRuleKey}
Request samples 
{
  • "claimRule_Key": 0,
  • "claimRule_Object": "string",
  • "claimRule_Result": "s",
  • "debug": true,
  • "description": "string",
  • "display": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "error_Code": "string",
  • "error_Type": "string",
  • "ex_Code": "string",
  • "process_If_Error": true,
  • "process_If_Override": true,
  • "required": true,
  • "system_Rule": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimRule
Deletes an ClaimRule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-rules/{claimRuleKey}
Request samples 
Create or Update Batch ClaimRule
Create or Update multiple ClaimRule 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 
claimRule_Key
required
integer <int32> 
 
claimRule_Object
string or null  <= 64 characters 
 
claimRule_Result
string or null  <= 1 characters 
 
debug
required
boolean
 
description
string or null  <= 512 characters 
 
display
string or null  <= 64 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
error_Code
string or null  <= 8 characters 
 
error_Type
string or null  <= 32 characters 
 
ex_Code
string or null  <= 6 characters 
 
process_If_Error
required
boolean
 
process_If_Override
required
boolean
 
required
required
boolean
 
system_Rule
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/claim-rules-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}