Claim Queue Notify User Groups

Create ClaimQueueNotifyGroup

Creates a new ClaimQueueNotifyGroup

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

ClaimQueue Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimQueue_Key
required
integer <int32>
userGroup_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-queues/{claimQueueKey}/notify-user-groups
Request samples
{
  • "claimQueue_Key": 0,
  • "userGroup_Key": 0,
  • "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 ClaimQueueNotifyGroup

Lists all ClaimQueueNotifyGroup for the given claimQueueKey

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

ClaimQueue 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/claim-queues/{claimQueueKey}/notify-user-groups
Request samples 
Response samples 
No sample
Get ClaimQueueNotifyGroup
Gets ClaimQueueNotifyGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimQueueKey
required
integer <int32> 
ClaimQueue Key


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-queues/{claimQueueKey}/notify-user-groups/{userGroupKey}
Request samples 
Response samples 
No sample
Delete ClaimQueueNotifyGroup
Deletes an ClaimQueueNotifyGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimQueueKey
required
integer <int32> 
ClaimQueue Key


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-queues/{claimQueueKey}/notify-user-groups/{userGroupKey}
Request samples 
Create or Update Batch ClaimQueueNotifyGroup
Create or Update multiple ClaimQueueNotifyGroup 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
claimQueueKey
required
integer <int32> 
ClaimQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
claimQueue_Key
required
integer <int32> 
 
userGroup_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/claim-queues/{claimQueueKey}/notify-user-groups-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}