Reinsurance Contract Factor Criterias

Create ReinsContractFactorCriteria

Creates a new ReinsContractFactorCriteria

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

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractFactorCriteria_Key
required
integer <int32>

Unique identifier for each contract factor criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Exclude
required
boolean

Indicates if the range entered is an exclusion range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Field
string or null <= 128 characters

The field that is part of the criteria (such as benefit, procedure code, diag code, etc.)

criteria_Value_From
string or null <= 128 characters

The range for this Criteria_Field.

criteria_Value_Thru
string or null <= 128 characters

The range for this Criteria_Field.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/factor-criterias
Request samples
{
  • "reinsContractFactorCriteria_Key": 0,
  • "criteria_Exclude": true,
  • "criteria_Field": "string",
  • "criteria_Value_From": "string",
  • "criteria_Value_Thru": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reinsContract_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractFactorCriteria

Lists all ReinsContractFactorCriteria for the given reinsContractKey

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

ReinsContract 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/reinsurance-contracts/{reinsContractKey}/factor-criterias
Request samples
Response samples
No sample

Get ReinsContractFactorCriteria

Gets ReinsContractFactorCriteria

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

ReinsContract Key

reinsContractFactorCriteriaKey
required
integer <int32>

ReinsContractFactorCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/factor-criterias/{reinsContractFactorCriteriaKey}
Request samples
Response samples
No sample

Update ReinsContractFactorCriteria

Updates a specific ReinsContractFactorCriteria.

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

ReinsContract Key

reinsContractFactorCriteriaKey
required
integer <int32>

ReinsContractFactorCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractFactorCriteria_Key
required
integer <int32>

Unique identifier for each contract factor criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Exclude
required
boolean

Indicates if the range entered is an exclusion range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Field
string or null <= 128 characters

The field that is part of the criteria (such as benefit, procedure code, diag code, etc.)

criteria_Value_From
string or null <= 128 characters

The range for this Criteria_Field.

criteria_Value_Thru
string or null <= 128 characters

The range for this Criteria_Field.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/factor-criterias/{reinsContractFactorCriteriaKey}
Request samples
{
  • "reinsContractFactorCriteria_Key": 0,
  • "criteria_Exclude": true,
  • "criteria_Field": "string",
  • "criteria_Value_From": "string",
  • "criteria_Value_Thru": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reinsContract_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractFactorCriteria

Deletes an ReinsContractFactorCriteria

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

ReinsContract Key

reinsContractFactorCriteriaKey
required
integer <int32>

ReinsContractFactorCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/factor-criterias/{reinsContractFactorCriteriaKey}
Request samples

Create or Update Batch ReinsContractFactorCriteria

Create or Update multiple ReinsContractFactorCriteria 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
reinsContractKey
required
integer <int32>

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
reinsContractFactorCriteria_Key
required
integer <int32>

Unique identifier for each contract factor criteria. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Exclude
required
boolean

Indicates if the range entered is an exclusion range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

criteria_Field
string or null <= 128 characters

The field that is part of the criteria (such as benefit, procedure code, diag code, etc.)

criteria_Value_From
string or null <= 128 characters

The range for this Criteria_Field.

criteria_Value_Thru
string or null <= 128 characters

The range for this Criteria_Field.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
207

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/factor-criterias-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}