User Groups

Create UserGroup

Creates a new UserGroup

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
userGroup_Key
required
integer <int32>

ID of the User Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 50 characters

Description of the User Group.

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/user-groups
Request samples
{
  • "userGroup_Key": 0,
  • "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 UserGroup

Lists all UserGroup

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/user-groups
Request samples 
Response samples 
No sample
Get UserGroup
Gets UserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/user-groups/{userGroupKey}
Request samples 
Response samples 
No sample
Update UserGroup
Updates a specific UserGroup.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userGroup_Key
required
integer <int32> 
ID of the User Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 50 characters 
Description of the User Group.


 
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/user-groups/{userGroupKey}
Request samples 
{
  • "userGroup_Key": 0,
  • "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 UserGroup
Deletes an UserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/user-groups/{userGroupKey}
Request samples 
Create or Update Batch UserGroup
Create or Update multiple UserGroup 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 
userGroup_Key
required
integer <int32> 
ID of the User Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 50 characters 
Description of the User Group.


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