Group Participation Incentives

Create GroupsParticipationIncentive

Creates a new GroupsParticipationIncentive

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupsParticipationIncentive_Key
required
integer <int32>

Unique indicator for each Participation Incentive record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 2048 characters

The description of the incentive being added.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

participationIncentive_ID
required
string [ 1 .. 32 ] characters

The participation incentive ID used for this setting.

update_Date
string <date-time>

Date when 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/group-participation-incentives
Request samples
{
  • "groupsParticipationIncentive_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "participationIncentive_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupsParticipationIncentive

Lists all GroupsParticipationIncentive

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/group-participation-incentives
Request samples 
Response samples 
No sample
Get GroupsParticipationIncentive
Gets GroupsParticipationIncentive


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupsParticipationIncentiveKey
required
integer <int32> 
GroupsParticipationIncentive Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/group-participation-incentives/{groupsParticipationIncentiveKey}
Request samples 
Response samples 
No sample
Update GroupsParticipationIncentive
Updates a specific GroupsParticipationIncentive.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupsParticipationIncentiveKey
required
integer <int32> 
GroupsParticipationIncentive Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupsParticipationIncentive_Key
required
integer <int32> 
Unique indicator for each Participation Incentive record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 2048 characters 
The description of the incentive being added.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
participationIncentive_ID
required
string  [ 1 .. 32 ] characters 
The participation incentive ID used for this setting.


 
update_Date
string <date-time> 
Date when 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/group-participation-incentives/{groupsParticipationIncentiveKey}
Request samples 
{
  • "groupsParticipationIncentive_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "participationIncentive_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupsParticipationIncentive
Deletes an GroupsParticipationIncentive


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupsParticipationIncentiveKey
required
integer <int32> 
GroupsParticipationIncentive Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/group-participation-incentives/{groupsParticipationIncentiveKey}
Request samples 
Create or Update Batch GroupsParticipationIncentive
Create or Update multiple GroupsParticipationIncentive 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 
groupsParticipationIncentive_Key
required
integer <int32> 
Unique indicator for each Participation Incentive record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 2048 characters 
The description of the incentive being added.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
participationIncentive_ID
required
string  [ 1 .. 32 ] characters 
The participation incentive ID used for this setting.


 
update_Date
string <date-time> 
Date when 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/group-participation-incentives-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}