Reinsurance Contract Criteria Details

Create ReinsContractCriteriaDetail

Creates a new ReinsContractCriteriaDetail

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractCriteriaDetail_Key
required
integer <int32>

Unique identifier for each criteria detail on this 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

reinsContractCriteria_Key
required
integer <int32>

References ReinsContractCriteria.ReinsContractCriteria_Key on 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}/criterias/{reinsContractCriteriaKey}/details
Request samples
{
  • "reinsContractCriteriaDetail_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",
  • "reinsContractCriteria_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractCriteriaDetail

Lists all ReinsContractCriteriaDetail for the given reinsContractCriteriaKey

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria 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}/criterias/{reinsContractCriteriaKey}/details
Request samples
Response samples
No sample

Get ReinsContractCriteriaDetail

Gets ReinsContractCriteriaDetail

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

reinsContractCriteriaDetailKey
required
integer <int32>

ReinsContractCriteriaDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}/details/{reinsContractCriteriaDetailKey}
Request samples
Response samples
No sample

Update ReinsContractCriteriaDetail

Updates a specific ReinsContractCriteriaDetail.

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

reinsContractCriteriaDetailKey
required
integer <int32>

ReinsContractCriteriaDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractCriteriaDetail_Key
required
integer <int32>

Unique identifier for each criteria detail on this 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

reinsContractCriteria_Key
required
integer <int32>

References ReinsContractCriteria.ReinsContractCriteria_Key on 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}/criterias/{reinsContractCriteriaKey}/details/{reinsContractCriteriaDetailKey}
Request samples
{
  • "reinsContractCriteriaDetail_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",
  • "reinsContractCriteria_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractCriteriaDetail

Deletes an ReinsContractCriteriaDetail

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

reinsContractCriteriaDetailKey
required
integer <int32>

ReinsContractCriteriaDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}/details/{reinsContractCriteriaDetailKey}
Request samples

Create or Update Batch ReinsContractCriteriaDetail

Create or Update multiple ReinsContractCriteriaDetail 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

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

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

Unique identifier for each criteria detail on this 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

reinsContractCriteria_Key
required
integer <int32>

References ReinsContractCriteria.ReinsContractCriteria_Key on 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}/criterias/{reinsContractCriteriaKey}/details-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}