Reinsurance Notify User Groups

Create ReinsContractNotifyGroup

Creates a new ReinsContractNotifyGroup

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

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent record. When notification is enabled for the reinsurance contract, this notes which user group to notify.

userGroup_Key
required
integer <int32>

The user group to be notified.

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/notify-user-groups
Request samples
{
  • "reinsContract_Key": 0,
  • "userGroup_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractNotifyGroup

Lists all ReinsContractNotifyGroup 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}/notify-user-groups
Request samples 
Response samples 
No sample
Get ReinsContractNotifyGroup
Gets ReinsContractNotifyGroup


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


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/reinsurance-contracts/{reinsContractKey}/notify-user-groups/{userGroupKey}
Request samples 
Response samples 
No sample
Delete ReinsContractNotifyGroup
Deletes an ReinsContractNotifyGroup


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


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/reinsurance-contracts/{reinsContractKey}/notify-user-groups/{userGroupKey}
Request samples 
Create or Update Batch ReinsContractNotifyGroup
Create or Update multiple ReinsContractNotifyGroup 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 
reinsContract_Key
required
integer <int32> 
References the ReinsContract.ReinsContract_Key on parent record. When notification is enabled for the reinsurance contract, this notes which user group to notify.


 
userGroup_Key
required
integer <int32> 
The user group to be notified.


 
Responses 
207
Success


401
Unauthorized


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