API::Announcements - RIEI/WiFiDB GitHub Wiki

User Documentation

URL: /api/accounc.php

Parameters:

• POST or GET (string) output: Supported are json, xml, or raw. Default is json. (See api::dev::Output for more info)

Description

The announcement API page is used to grab the latest announcement that is set in WiFiDB. On the browser pages this is seen as a banner along the top of the pages. The API can be used for clients that connect to WiFiDB to show maintenance windows or other information.

---

Developer Documentation

###File path: /api/announc.php

Description

There really isn't much to this API call. It calls the dbcore::GetAnnouncement() method and sends the return to the api::Output() method. The GetAnnouncement() method only gets the latest announcement from the database.

Classes used

dbcore->GetLatestAnnoucement() is the only function used.