matekasse/Website/templates/documentation.html
2024-02-21 22:02:07 +01:00

44 lines
1.6 KiB
HTML

{% extends "base.html" %}
{% block title %}
Documentation
{% endblock %}
{% block customscript %}
<link rel="stylesheet" type="text/css" href="documentation.css">
{% endblock %}
{% block content %}
<h1 class="header"> <u>Documentation</u> </h1>
<p>&nbsp;</p>
<div id="text">
<h2>API:</h2>
<p>http://matekasse.server.c3h/api/tag_id</p>
<p>Post method {"id":tag_id}</p>
<p>Response:
{"mode":"error" "error":"{error}"} or
{"mode":"message","username":"{username}","message":"{message}"} or
{"mode":"balance", "username":"{username}", "balance":"{balance}"}
</p>
<br></br>
<p>http://matekasse.server.c3h/api/balance</p>
<p>Post method {"id":user_id, "change":change}</p>
<p>
If change = None or NaN the change will be -1
</p>
<p>Get method ?id=user_id</p>
<p>
Response:
{"mode":"error" "error":"{error}"} or
{"mode":"balance", "username":"{username}", "balance":"{balance}"}
</p>
<br></br>
<h2>Error Codes:</h2>
<p>170: Tag already in use</p>
<p>054: Tag does not exists</p>
<p>757: User already exists</p>
<p>043: User does not exists</p>
<p>352: Timeout</p>
<p>095: Input is not a Number</p>
<p>638: Wrong Input</p>
<P>418: I'm a teapot</P>
</div>
{% endblock %}