Skip to content

API Overview

Alexander Schulze edited this page Jul 11, 2013 · 2 revisions

Betatext implements a REST API to get and set texts, comments, votes etc. The Base URL will be http://www.example.com/rest.php all requests will add to this base URL.

All data is send as JSON.

Requests

  • Text
    • get a commentable text
  • Comment
    • get a comment
    • post a new comment
    • delete a comment
  • Vote
    • like/dislike a comment
  • User
    • get the logged in user
    • login a user
    • logout a user
  • Process Step
    • get the process steps of a text

Models

Error Codes

  • HTTP 404: ID is non-existent
  • HTTP 401: User is not logged in
  • HTTP 500: Database error
  • HTTP 405: Method not allowed

Home > API

Requests

  • Text
    • get a commentable text
  • Comment
    • get a comment
    • post a new comment
    • delete a comment
  • Vote
    • like/dislike a comment
  • User
    • get the logged in user
    • login a user
    • logout a user
  • Process Step
    • get the process steps of a text

Models

Clone this wiki locally