List of APIs related to Announcement
1. Get details of the announcement.
2. Add log if the announcement is active.
Format - uuid. Announcement ID
Populate additional information. Accepted entities: creator, lastUpdatedUser
Returns an [API_Announcement.API.Announcement] object
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Get the list of active announcements (for all teaching/enrolled modules) that are accessible to the login user.
2. Add log if titleOnly is set to false
Format - int32.
Format - int32.
Populate additional information. Accepted entities: creator, lastUpdatedUser
True by default. Set to False to return announcement details and add log.
Returns list of [API_Announcement.API.Announcement]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Get the list of unread announcements (for all teaching/enrolled modules) that are accessible to the login user.
2. Add log for all active announcements if titleOnly is set to false
Format - int32.
Format - int32.
Populate additional information. Accepted entities: creator, lastUpdatedUser
True by default. Set to False to return announcement details and add log.
Returns list of [API_Announcement.API.Announcement]
[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]
[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Update an announcement.
2. Only users with Access_Setting_Update access to the announcement can update it.
3. If InheritedResourceID is valid, the announcement will inherit its access rights from InheritedResourceID.
4. If InheritedResourceID is null but group and/or user access are/is defined, the groups and users will have access to the announcement.
5. If InheritedResourceID is null and no group/user access is defined, only creator will have access to the announcement.
Announcement to update
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
Returns the record updated
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Create a new announcement and add log for the login user.
2. Only users with Access_Setting_Update access to the module can create a new announcement.
3. If InheritedResourceID is valid, the announcement will inherit its access rights from InheritedResourceID.
4. If InheritedResourceID is null but group and/or user access are/is defined, the groups and users will have access to the announcement.
5. If InheritedResourceID is null and no group/user access is defined, only creator will have access to the announcement.
Announcement to create
{
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
Returns the record inserted
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
Only users with Access_Delete access to the announcements can delete them.
IDs of the announcements to delete.
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
{
"iDs": [
"string"
]
}
Returns IDs of the announcements deleted
[
"string"
]
[
"string"
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Publish or unpublish an announcement.
2. Only users with Access_Setting_Update access to the announcement can publish or unpublish it.
Announcement ID and publish status
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
{
"id": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": false,
"email": false,
"excludeOwner": false,
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
}
}
Returns the record updated
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Get the list of active announcements (for one module) that are accessible to the login user.
2. Add log if titleOnly is set to false.
Format - uuid. Parent ID, e.g. ModuleID
Format - int32.
Format - int32.
Populate additional information. Accepted entities: creator, lastUpdatedUser
True by default. Set to False to return announcement details and add log.
Returns list of [API_Announcement.API.Announcement]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Non-archived announcements include both scheduled and active announcements.
2. Get the list of non-archived announcements (for one module) that are accessible to the login user.
3. Add log for all active announcements if titleOnly is set to false.
4. Only users with Access_Setting_Read access to the scheduled announcements can view them.
Format - uuid. Parent ID, e.g. ModuleID
Format - int32.
Format - int32.
Populate additional information. Accepted entities: creator, lastUpdatedUser
True by default. Set to False to return announcement details and add log.
Returns list of [API_Announcement.API.Announcement]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
[
{
"id": "string",
"parentID": "string",
"title": "string",
"description": "string",
"displayFrom": "string",
"expireAfter": "string",
"archiveAfter": "string",
"publish": true,
"sms": true,
"email": true,
"excludeOwner": true,
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"createdDate": "string",
"creatorID": "string",
"creatorName": "string",
"creatorUserID": "string",
"creatorEmail": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastUpdatedByName": "string",
"lastUpdatedByUserID": "string",
"lastUpdatedByEmail": "string"
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string
1. Get the list of archived announcements (for one module) that are accessible to the login user.
2. Only users with Access_Setting_Read access to the archived announcements can view them.
Format - uuid. Parent ID, e.g. ModuleID
Format - int32.
Format - int32.
Populate additional information. Accepted entities: creator, lastUpdatedUser
True by default. Set to False to return announcement details.
Returns list of [API_Announcement.API.Announcement]
[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]
[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]
Bad Request
string
string
Login user not authorized to perform this action
string
string
Not Found
string
string
Server Error
string
string