Lookup Data #
| Id | Role |
|---|---|
| 1 | Group Administrator |
| 2 | Application Administrator |
| 3 | Resource Administrator |
| 4 | Schedule Administrator |
GET Methods #
Get All Groups #
Description
Gets all groups.
Route
/Groups/
Authentication
This service is secure and requires authentication headers
Example Response
{
"groups": [
{
"id": 1,
"name": "group name",
"isDefault": true,
"links": [],
"message": null
}
],
"links": [],
"message": null
}Get Group #
Description
Gets a specific group by id.
Route
/Groups/:groupId
Authentication
This service is secure and requires authentication headers
Example Response
{
"id": 123,
"name": "group name",
"adminGroup": "http:\/\/url\/to\/group",
"permissions": [
"http:\/\/url\/to\/resource"
],
"viewPermissions": [
"http:\/\/url\/to\/resource"
],
"users": [
"http:\/\/url\/to\/user"
],
"roles": [
1,
2
],
"isDefault": true,
"links": [],
"message": null
}POST Methods #
Create Group #
Description
Creates a new group.
Route
/Groups/
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Request
{
"name": "group name",
"isDefault": true
}Example Response
{
"groupId": 1,
"links": [
{
"href": "http:\/\/url\/to\/group",
"title": "get_group"
},
{
"href": "http:\/\/url\/to\/update\/group",
"title": "update_group"
},
{
"href": "http:\/\/url\/to\/delete\/group",
"title": "delete_group"
}
],
"message": null
}Update Group #
Description
Updates and existing group.
Route
/Groups/:groupId
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Request
{
"name": "group name",
"isDefault": true
}Example Response
{
"groupId": 1,
"links": [
{
"href": "http:\/\/url\/to\/group",
"title": "get_group"
},
{
"href": "http:\/\/url\/to\/update\/group",
"title": "update_group"
},
{
"href": "http:\/\/url\/to\/delete\/group",
"title": "delete_group"
}
],
"message": null
}Change Group Roles #
Description
Updates the roles for an existing group.
Route
/Groups/:groupId/Roles
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Request
{
"roleIds": [
1,
2,
3,
4
]
}Example Response
{
"groupId": 1,
"links": [
{
"href": "http:\/\/url\/to\/group",
"title": "get_group"
},
{
"href": "http:\/\/url\/to\/update\/group",
"title": "update_group"
},
{
"href": "http:\/\/url\/to\/delete\/group",
"title": "delete_group"
}
],
"message": null
}Change Group Permissions #
Description
Updates the resource permissions for an existing group.
Route
/Groups/:groupId/Permissionss
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Request
{
"permissions": [
4,
5,
6
],
"viewPermissions": [
1,
2,
3
]
}Example Response
{
"groupId": 1,
"links": [
{
"href": "http:\/\/url\/to\/group",
"title": "get_group"
},
{
"href": "http:\/\/url\/to\/update\/group",
"title": "update_group"
},
{
"href": "http:\/\/url\/to\/delete\/group",
"title": "delete_group"
}
],
"message": null
}Change Group Users #
Description
Updates the users belonging to an existing group.
Route
/Groups/:groupId/Users
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Request
{
"userIds": [
4,
5,
6
]
}Example Response
{
"groupId": 1,
"links": [
{
"href": "http:\/\/url\/to\/group",
"title": "get_group"
},
{
"href": "http:\/\/url\/to\/update\/group",
"title": "update_group"
},
{
"href": "http:\/\/url\/to\/delete\/group",
"title": "delete_group"
}
],
"message": null
}DELETE Methods #
Delete Group #
Description
Deletes an existing group.
Route
/Groups/:groupId
Authentication
This service is secure and requires authentication headers
This service is only available to application administrators
Example Response
{
"links": [],
"message": "The item was deleted"
}
