API Documentation

Endpoints

Description

Search

GET Content Find a collection of posts and filter your list using facets including location, user, noticeboard, tags, etc. Example:
http://n0ticeapis.com/2/search?type=report&location=Hackney

Auth

User Authentication

Users

GET User ID Get details about a user including how many followers she has and what she has posted. Example:
http://n0ticeapis.com/2/user/sarahhartley
GET User Dashboard Get everything required to build a user’s dashboard page, including what she follows and what posts belong in her news stream. Example:
http://n0ticeapis.com/2/user/sarahhartley/dashboard
GET Suggested Users Get a list of users that this user might want to follow. Example:
http://n0ticeapis.com/2/suggest/users?user=girlondon
GET User Notifications Get messages and notifications sent by the system to a user. Authentication required.
POST Follow/Unfollow User ID Add a user ID to a follow list for an authenticated user, or remove a user ID from an authenticated user’s follow list

Noticeboards

GET Noticeboards Get a list of all the noticeboards available on n0tice.com. Example:
http://n0ticeapis.com/2/noticeboards
GET Noticeboard ID Get details about a noticeboard including how many followers it has and what has been posted to it. Example:
http://n0ticeapis.com/2/noticeboard/streetart
GET Suggested Noticeboards Get a list of noticeboards that this user might want to follow. Example:
http://n0ticeapis.com/2/suggest/noticeboards?user=girlondon
POST Follow/Unfollow Noticeboard Add a noticeboard ID to a follow list for an authenticated user, or remove a noticeboard ID from an authenticated user’s follow list

Reports

GET Report ID Get all the data for a single report. Example:
http://n0ticeapis.com/2/report/2550
GET Interesting Votes for a Report ID Get all the voting data for a single report ID. Example:
http://n0ticeapis.com/2/report/2364/votes/interesting
GET Reposts for a Report ID Get all the repost data for a single report ID. Example:
http://n0ticeapis.com/2/report/2364/reposts
GET Report Update ID Get all the data for a single update to a report. Example:
http://n0ticeapis.com/2/report/2310/update/2603
POST New Report Post a new report on behalf of an authenticated user.
POST New Update to Report ID Post a new update to a report on behalf of an authenticated user.
POST Interesting Vote Submit an ‘Interesting’ vote to a report ID on behalf of a user
POST Repost Report ID to a Noticeboard Repost a report to a noticeboard on behalf of a user who is an admin for that noticeboard

Events

GET Event ID Get all the data for a single event. Example:
http://n0ticeapis.com/2/event/1198
GET Interesting Votes for an Event ID Get all the voting data for a single event ID. Example:
http://n0ticeapis.com/2/event/1198/votes/interesting
GET Reposts for an Event ID Get all the repost data for a single event ID. Example:
http://n0ticeapis.com/2/event/1198/reposts
GET Event Update ID Get all the data for a single update to an event. Example:
http://n0ticeapis.com/2/event/1431/update/1621
POST New Event Post a new event on behalf of an authenticated user.
POST New Update to Event ID Post a new update to an event on behalf of an authenticated user.
POST Interesting Vote to an Event Submit an ‘Interesting’ vote to an event ID on behalf of a user
POST Repost Event ID to a Noticeboard Repost an event to a noticeboard on behalf of a user who is an admin for that noticeboard

Offers

GET Offer ID Get all the data for a single offer. Example:
http://n0ticeapis.com/2/offer/437

Errors

Error Codes & Responses HTTP status codes returned with your API requests.