Group Announcement API
The calls to the /api/group_announcement API endpoint allow to view, add, and delete Group's edit access to announcements.
Prerequisites:
- Set up API access
- Verify that you have API access and obtain a token via get_token call
Table of contents:
1. Access Admin > System > API Toolkit
2. Get Group's Announcement Edit Access
- Item: group_announcement
- Methods: GET
-
Optionally, provide values for the following parameters to filter out the returned data:
- ID: The ID of the Group/Announcement pair (see Fields Description for details)
- group: The ID of the Group
- Enter an API Token
- [Run request]
- The returned object contains an array of objects each of which contains information about a Group's access to an Announcement
- See Example Response and Fields Description for details
{
"group_announcements": [
{
"id": "1",
"group": "53",
"announcement": "22",
"edit_access": "Y"
},
{
"id": "2",
"group": "53",
"announcement": "33",
"edit_access": "Y"
},
{
"id": "3",
"group": "60",
"announcement": "10",
"edit_access": "Y"
}
]
}Fields Description
3. Add Announcement Edit Access to Group
- Item: group_announcement
- Methods: POST
- Enter an ID of the existing Group/Announcement pair
- See Fields Description for details
- Select JSON request and provide the corresponding values for the following parameters:
- announcement: The ID of the Announcement
- group: The ID of the Group
- Enter an API Token
- [Run request]
- The returned object contains an object with information about a Group's edit access to an Announcement
- See Example Response and Fields Description for details
4. Delete Group's Announcement Edit Access
- Item: group_announcement
- Methods: DELETE
- Enter an ID of the existing Group/Announcement pair that needs to be deleted
- See Fields Description for details
- Enter an API Token
- [Run request]