Reinsurance Contract Cycles

Create ReinsContractCycle

Creates a new ReinsContractCycle

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
contract_Cycle
required
string [ 1 .. 32 ] characters

Unique identifier for each Contract Cycle.

cycle_Frequency
integer or null <int32>

The frequency for this reinsurance cycle based on Cycle_Type.

cycle_Type
string or null <= 1 characters

In combination with Cycle_Frequency, dertermines the reinsurance cycle.

description
string or null <= 128 characters

The description for this cycle.

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

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-contract-cycles
Request samples
{
  • "contract_Cycle": "string",
  • "cycle_Frequency": 0,
  • "cycle_Type": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractCycle

Lists all ReinsContractCycle

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/reinsurance-contract-cycles
Request samples
Response samples
No sample

Get ReinsContractCycle

Gets ReinsContractCycle

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
contractCycle
required
string

Contract Cycle

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contract-cycles/{contractCycle}
Request samples
Response samples
No sample

Update ReinsContractCycle

Updates a specific ReinsContractCycle.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
contractCycle
required
string

Contract Cycle

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
contract_Cycle
required
string [ 1 .. 32 ] characters

Unique identifier for each Contract Cycle.

cycle_Frequency
integer or null <int32>

The frequency for this reinsurance cycle based on Cycle_Type.

cycle_Type
string or null <= 1 characters

In combination with Cycle_Frequency, dertermines the reinsurance cycle.

description
string or null <= 128 characters

The description for this cycle.

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

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-contract-cycles/{contractCycle}
Request samples
{
  • "contract_Cycle": "string",
  • "cycle_Frequency": 0,
  • "cycle_Type": "s",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractCycle

Deletes an ReinsContractCycle

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
contractCycle
required
string

Contract Cycle

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contract-cycles/{contractCycle}
Request samples

Create or Update Batch ReinsContractCycle

Create or Update multiple ReinsContractCycle 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
contract_Cycle
required
string [ 1 .. 32 ] characters

Unique identifier for each Contract Cycle.

cycle_Frequency
integer or null <int32>

The frequency for this reinsurance cycle based on Cycle_Type.

cycle_Type
string or null <= 1 characters

In combination with Cycle_Frequency, dertermines the reinsurance cycle.

description
string or null <= 128 characters

The description for this cycle.

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

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-contract-cycles-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}