Skip to content
On this page

Announcement


An announcement API resource represents a site-wide message to be broadcasted on the homepage.

For example, if video streaming is disabled, the site staff may issue a "Video streaming has been disabled!" announcement.

Fields

NameTypeNullableDefaultDescription
idIntegerNoYesThe primary key of the resource
contentStringNoYesThe announcement text
created_atDateNoNoThe date that the resource was created
updated_atDateNoNoThe date that the resource was last modified
deleted_atDateYesNoThe date that the resource was deleted

Allowed Include Paths

None

Endpoints

Announcement Destroy

The announcement destroy endpoint soft deletes an announcement and returns the deleted announcement resource.

Announcement Force Delete

The announcement force delete endpoint hard deletes an announcement and returns a confirmation message.

Announcement Index

The announcement index endpoint displays a listing of announcement resources.

Announcement Restore

The announcement restore endpoint restores a soft deleted announcement and returns the restored announcement resource.

Announcement Show

The announcement show endpoint returns an announcement resource.

Announcement Store

The announcement store endpoint creates a new announcement and returns the new announcement resource.

Announcement Update

The announcement update endpoint updates an announcement and returns the updated announcement resource.

Released under the MIT License.