API GroupPermissions
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See GroupPermission Database Schema.
GroupPermissions GET (single)
Version Added: 26.1
Gets a single grouppermission.
Parameters:
GroupPermissionNum: Required in URL.
Example Request:
GET /grouppermissions/1
Example Response:
{
"GroupPermNum": 1,
"NewerDate": "0001-01-01",
"NewerDays": 0,
"UserGroupNum": 1,
"PermType": "FamilyModule",
"FKey": 0
}
200 OK
404 NotFound (with explanation)
GroupPermissions GET (multiple)
Version Added: 26.1
Gets a list of grouppermissions.
Parameters: All Optional.
UserGroupNum: FK to usergroup.UserGroupNum. The user group for which this permission is granted.
PermType: EnumPermType. See GroupPermission Database Schema for the full list of acceptable values.
Example Requests:
GET /grouppermissions
GET /grouppermissions?UserGroupNum=23
GET /grouppermissions?PermType=FamilyModule
GET /grouppermissions?UserGroupNum=23&PermType=FamilyModule
Example Response:
[
{
"GroupPermNum": 1,
"NewerDate": "0001-01-01",
"NewerDays": 0,
"UserGroupNum": 1,
"PermType": "FamilyModule",
"FKey": 0
},
{
"GroupPermNum": 2,
"NewerDate": "0001-01-01",
"NewerDays": 0,
"UserGroupNum": 2,
"PermType": "AppointmentsModule",
"FKey": 0
},
{
"GroupPermNum": 3,
"NewerDate": "0001-01-01",
"NewerDays": 0,
"UserGroupNum": 3,
"PermType": "ManageModule",
"FKey": 0
},
etc...
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)