Reinsurance Notify Users

Create ReinsContractNotifyUser

Creates a new ReinsContractNotifyUser

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 to notify.

user_ID
required
string [ 1 .. 20 ] characters

The user to be notified.

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/notify-users
Request samples
{
  • "reinsContract_Key": 0,
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractNotifyUser

Lists all ReinsContractNotifyUser 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-users
Request samples 
Response samples 
No sample
Get ReinsContractNotifyUser
Gets ReinsContractNotifyUser


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


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/reinsurance-contracts/{reinsContractKey}/notify-users/{userID}
Request samples 
Response samples 
No sample
Delete ReinsContractNotifyUser
Deletes an ReinsContractNotifyUser


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


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/reinsurance-contracts/{reinsContractKey}/notify-users/{userID}
Request samples 
Create or Update Batch ReinsContractNotifyUser
Create or Update multiple ReinsContractNotifyUser 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 to notify.


 
user_ID
required
string  [ 1 .. 20 ] characters 
The user to be notified.


 
Responses 
207
Success


401
Unauthorized


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