Get Student Announcement
Returns the announcements one learner can see, with whether they have read each one. Use it to check, on a learner's behalf, which notices they have or have not seen.
/admin/student/announcement/{studentId}curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/admin/student/announcement/{studentId}?bundle_ids=<Integer Course Id>&search=<Search String>&page=1&per_page=<per_page>&read_unread=0&urgency=<Urgency>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"announcements": [
{
"institution_announcement_id": "8305",
"announcement_type": "1",
"announcement_resource_type": "2",
"announcement_image": "",
"title": "sdafcds",
"message": "<p>sdfsdf</p>\n",
"status": "1",
"created_by": "89521522",
"created_at": "1702972718",
"created_by_name": "Super Admin 2",
"updated_by_name": "Super Admin 2",
"updated_by": "89521522",
"updated_at": "1702972718",
"resource": {
"institution_announcement_id": 8305,
"total_student_count": 25,
"total_bundle_count": 1,
"bundles": [
{
"bundle_id": 22250,
"bundle_name": "Unreal Engine 5: The Complete Beginner's Course",
"master_batches": [
{
"master_batch_id": 59011,
"master_batch_name": "UE 5: Batch Nov 2022",
"student_count": 19
},
{
"master_batch_id": 80737,
"master_batch_name": "New batch for rating testing",
"student_count": 4
},
{
"master_batch_id": 58917,
"master_batch_name": "Unreal Engine 5: The Complete Beginner's Course",
"student_count": 2
}
]
}
]
},
"urgency": 3,
"announcement_visibility": 0,
"custom_fields": [],
"read_status": 1
},
{
"institution_announcement_id": "8304",
"announcement_type": "1",
"announcement_resource_type": "2",
"announcement_image": "",
"title": "adsfds",
"message": "<p>sdfsdf</p>\n",
"status": "1",
"created_by": "89521522",
"created_at": "1702972696",
"created_by_name": "Super Admin 2",
"updated_by_name": "Super Admin 2",
"updated_by": "89521522",
"updated_at": "1702972696",
"resource": {
"institution_announcement_id": 8304,
"total_student_count": 25,
"total_bundle_count": 1,
"bundles": [
{
"bundle_id": 22250,
"bundle_name": "Unreal Engine 5: The Complete Beginner's Course",
"master_batches": [
{
"master_batch_id": 59011,
"master_batch_name": "UE 5: Batch Nov 2022",
"student_count": 19
},
{
"master_batch_id": 80737,
"master_batch_name": "New batch for rating testing",
"student_count": 4
},
{
"master_batch_id": 58917,
"master_batch_name": "Unreal Engine 5: The Complete Beginner's Course",
"student_count": 2
}
]
}
]
},
"urgency": 2,
"announcement_visibility": 0,
"custom_fields": [],
"read_status": 1
},
{
"institution_announcement_id": "8303",
"announcement_type": "1",
"announcement_resource_type": "2",
"announcement_image": "",
"title": "Dmeo",
"message": "<p>sdfds</p>\n",
"status": "1",
"created_by": "89521522",
"created_at": "1702972146",
"created_by_name": "Super Admin 2",
"updated_by_name": "Super Admin 2",
"updated_by": "89521522",
"updated_at": "1702972146",
"resource": {
"institution_announcement_id": 8303,
"total_student_count": 25,
"total_bundle_count": 1,
"bundles": [
{
"bundle_id": 22250,
"bundle_name": "Unreal Engine 5: The Complete Beginner's Course",
"master_batches": [
{
"master_batch_id": 59011,
"master_batch_name": "UE 5: Batch Nov 2022",
"student_count": 19
},
{
"master_batch_id": 80737,
"master_batch_name": "New batch for rating testing",
"student_count": 4
},
{
"master_batch_id": 58917,
"master_batch_name": "Unreal Engine 5: The Complete Beginner's Course",
"student_count": 2
}
]
}
]
},
"urgency": 2,
"announcement_visibility": 0,
"custom_fields": [],
"read_status": 1
},
{
"institution_announcement_id": "3399",
"announcement_type": "1",
"announcement_resource_type": "2",
"announcement_image": "https://dme2wmiz2suov.cloudfront.net/Institution(1613)/Announcement/2213219-1980017-Mobile.jpg?Expires=1704788180&Signature=RwsyYlXvoj3EtgJer1~Mm7zkUnvoSZvYNZQMTK5nqSqaXXLrZ-pD0BJrCePwnCbO-Pcen9uhg0NJnpTGc3oF6uihtTONp1b~WHr3JOqjMsQZ30vXASwCc2jlvTfO9Ct2l5S6kxYQY-0Hp2TdSSGceL6Z0uVPCyG3zZBWWbB6cQIx9zh5JSK6UVFgGRWeAQzZgE5gh4zHvzpBg-yJSegALPElOclDGRUahckulWFNXqX~Enfh3CYMWzHydNuntAdofBjeKIBXZYPE7vVcPfMzzJGvwOxtr8kvdQn3kaaUDIxrK40o7W7v-x6bx5PsikIuopGHLI2l7dLkQem1MJr20w__&Key-Pair-Id=APKAIIFZDCEANAVU2VTA",
"title": "test announcement 2",
"message": "<p>qwert yuio asdfgh jklzxcv bnmsd fghjk </p>\n",
"status": "1",
"created_by": "53044146",
"created_at": "1689924599",
"created_by_name": "Edmingle Academy",
"updated_by_name": "Super Admin 2",
"updated_by": "89521522",
"updated_at": "1702972642",
"resource": {
"institution_announcement_id": 3399,
"total_student_count": 60,
"total_bundle_count": 4,
"bundles": [
{
"bundle_id": 22272,
"bundle_name": "Adobe Lightroom for Absolute Beginners",
"master_batches": [
{
"master_batch_id": 60428,
"master_batch_name": "Test batch mail ics",
"student_count": 3
},
{
"master_batch_id": 58973,
"master_batch_name": "Adobe Lightroom for Absolute Beginners",
"student_count": 10
}
]
},
{
"bundle_id": 22250,
"bundle_name": "Unreal Engine 5: The Complete Beginner's Course",
"master_batches": [
{
"master_batch_id": 59011,
"master_batch_name": "UE 5: Batch Nov 2022",
"student_count": 19
},
{
"master_batch_id": 80737,
"master_batch_name": "New batch for rating testing",
"student_count": 4
},
{
"master_batch_id": 58917,
"master_batch_name": "Unreal Engine 5: The Complete Beginner's Course",
"student_count": 2
}
]
},
{
"bundle_id": 22251,
"bundle_name": "Master Architectural Visualization - Blender - Design",
"master_batches": [
{
"master_batch_id": 80749,
"master_batch_name": "rating test batch 2",
"student_count": 4
},
{
"master_batch_id": 59051,
"master_batch_name": "GetApiTest",
"student_count": 4
},
{
"master_batch_id": 58919,
"master_batch_name": "Master Architectural Visualization - Blender - Design",
"student_count": 8
}
]
},
{
"bundle_id": 22269,
"bundle_name": "Character Art School: Complete Character Drawing",
"master_batches": [
{
"master_batch_id": 58969,
"master_batch_name": "Character Art School: Complete Character Drawing",
"student_count": 6
}
]
}
]
},
"urgency": 1,
"announcement_visibility": 1,
"custom_fields": [
{
"custom_field_id": 1,
"feature_custom_field_id": 2,
"institution_id": 1613,
"field_name": "test_0",
"field_display_name": "Test",
"field_type": 5,
"possible_values": [
{
"name": "Test",
"value": "Test",
"status": 0,
"display_index": 1
},
{
"name": "test2",
"value": "test2",
"status": 1,
"display_index": 2
},
{
"name": "test3",
"value": "test3",
"status": 1,
"display_index": 3
}
],
"help_text": "",
"required": 0,
"status": 1,
"display_index": 1,
"field_value": [
{
"name": "test3",
"value": "test3",
"status": 1,
"display_index": 3
}
]
},
{
"custom_field_id": 2,
"feature_custom_field_id": 2,
"institution_id": 1613,
"field_name": "option_1",
"field_display_name": "Option",
"field_type": 5,
"possible_values": [
{
"name": "Option 1",
"value": "Option 1",
"status": 1,
"display_index": 1
},
{
"name": "Option 2",
"value": "Option 2",
"status": 1,
"display_index": 2
},
{
"name": "Option 3 Option 4 Option 5 Option 6 Option 7 Option 8",
"value": "Option 3 Option 4 Option 5 Option 6 Option 7 Option 8",
"status": 1,
"display_index": 3
}
],
"help_text": "",
"required": 0,
"status": 1,
"display_index": 2,
"field_value": [
{
"name": "Option 1",
"value": "Option 1",
"status": 1,
"display_index": 1
},
{
"name": "Option 3 Option 4 Option 5 Option 6 Option 7 Option 8",
"value": "Option 3 Option 4 Option 5 Option 6 Option 7 Option 8",
"status": 1,
"display_index": 3
}
]
},
{
"custom_field_id": 3,
"feature_custom_field_id": 2,
"institution_id": 1613,
"field_name": "field_2",
"field_display_name": "Field",
"field_type": 5,
"possible_values": [
{
"name": "Field 1",
"value": "Field 1",
"status": 1,
"display_index": 1
},
{
"name": "Field 2",
"value": "Field 2",
"status": 1,
"display_index": 2
},
{
"name": "Field 3",
"value": "Field 3",
"status": 1,
"display_index": 3
},
{
"name": "Field 4",
"value": "Field 4",
"status": 1,
"display_index": 4
},
{
"name": "Field 5",
"value": "Field 5",
"status": 1,
"display_index": 5
},
{
"name": "Field 6",
"value": "Field 6",
"status": 1,
"display_index": 6
},
{
"name": "Field 7",
"value": "Field 7",
"status": 1,
"display_index": 7
}
],
"help_text": "",
"required": 0,
"status": 1,
"display_index": 3,
"field_value": [
{
"name": "Field 1",
"value": "Field 1",
"status": 1,
"display_index": 1
},
{
"name": "Field 2",
"value": "Field 2",
"status": 1,
"display_index": 2
},
{
"name": "Field 3",
"value": "Field 3",
"status": 1,
"display_index": 3
},
{
"name": "Field 4",
"value": "Field 4",
"status": 1,
"display_index": 4
},
{
"name": "Field 5",
"value": "Field 5",
"status": 1,
"display_index": 5
},
{
"name": "Field 6",
"value": "Field 6",
"status": 1,
"display_index": 6
},
{
"name": "Field 7",
"value": "Field 7",
"status": 1,
"display_index": 7
}
]
},
{
"custom_field_id": 4,
"feature_custom_field_id": 2,
"institution_id": 1613,
"field_name": "custom_3",
"field_display_name": "Custom",
"field_type": 5,
"possible_values": [
{
"name": "Custom 1",
"value": "Custom 1",
"status": 1,
"display_index": 1
},
{
"name": "Custom 2",
"value": "Custom 2",
"status": 1,
"display_index": 2
},
{
"name": "Custom 3",
"value": "Custom 3",
"status": 1,
"display_index": 3
},
{
"name": "CustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustom",
"value": "CustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustomCustom",
"status": 1,
"display_index": 4
}
],
"help_text": "",
"required": 0,
"status": 1,
"display_index": 4,
"field_value": [
{
"name": "Custom 1",
"value": "Custom 1",
"status": 1,
"display_index": 1
},
{
"name": "Custom 3",
"value": "Custom 3",
Access: Institute admins and admins. The learner must belong to your ORGID organization.
admin/student/announcement/43974.end: only announcements created in this window.start: end of the window (exclusive).0 unread only, 1 read only, 0,1 both.AND (default) or OR, how cf_filter conditions combine.Response: announcements is an array, newest first. Each has institution_announcement_id, title, message (HTML), announcement_image (image link or empty), announcement_type, announcement_resource_type (1 sent to the whole organization, 2 sent to selected courses or batches), announcement_visibility, urgency, status (1 active), read_status (1 read, 0 unread), created_by and created_by_name, created_at (Unix timestamp), updated_by, updated_by_name, updated_at, custom_fields, and resource (the courses and batches it was sent to). page_context gives page, per_page, total_rows and has_more_page.
Notes: Only active announcements the learner can see are returned: ones sent to the whole organization, ones sent to their courses or batches, and ones addressed to them directly. IDs and timestamps are returned as strings. Returns "student not found in organization" if the learner is not in your ORGID organization. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.